sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-25 00:58:06 -05:00
Code Issues Packages Projects Releases Wiki Activity
QGIS/python/core/__init__.py.in

113 lines
5.2 KiB
Python
Raw Normal View History

add missing copyright headers
2016-01-08 21:31:41 +01:00
# -*- coding: utf-8 -*-
"""
***************************************************************************
__init__.py
---------------------
Date : May 2014
Copyright : (C) 2014 by Nathan Woodrow
Email : woodrow dot nathan at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
__author__ = 'Nathan Woodrow'
__date__ = 'May 2014'
__copyright__ = '(C) 2014, Nathan Woodrow'
bring back PyQt.QtCore.NULL in qgis.core
2018-05-14 19:53:02 -04:00
from qgis.PyQt.QtCore import NULL
Create Python package for core, gui, analysis, networkanalysis Rename sip generated modules to _{name}
2014-05-19 21:40:26 +10:00
from qgis._core import *
Move qgsfunction to qgis.core. Add new register_function method when not using decorator Wrap function call in try block to catch and report errors
2014-11-29 18:37:23 +10:00
[pyqgis] move qgis.core tricks to their own python file in additions folder this makes the code much easier to read
2018-05-14 11:30:27 -04:00
from .additions.edit import edit, QgsEditError
from .additions.fromfunction import fromFunction
[pyqgis] add method to retrieve metaEnum from an enum value or type (#7023)
2018-05-18 06:47:18 -08:00
from .additions.metaenum import metaEnumFromType, metaEnumFromValue
[pyqgis] move qgis.core tricks to their own python file in additions folder this makes the code much easier to read
2018-05-14 11:30:27 -04:00
from .additions.processing import processing_output_layer_repr, processing_source_repr
move additions from top __init__ to core.__init__
2018-05-16 11:29:28 -04:00
from .additions.projectdirtyblocker import ProjectDirtyBlocker
Patch QgsProviderMetadata in Python to avoid API break In C++ we do not support QgsProviderMetadata(key, description, createFunc) anymore, but for python code we can have a patched class that still supports createFunc. Why not keep the variant with createFunc in C++ as well? Because... SIP! With newly added virtual methods in QgsProviderMetadata, SIP started to generate a sip-specific subclass to handle derived classes in Python, however due to the variant with PyObject* and custom MethodCode it was getting confused about what constructors are available in C++ and failing to compile.
2019-06-21 18:27:36 +02:00
from .additions.providermetadata import PyProviderMetadata
move additions from top __init__ to core.__init__
2018-05-16 11:29:28 -04:00
from .additions.qgsfeature import mapping_feature
from .additions.qgsfunction import register_function, qgsfunction
from .additions.qgsgeometry import _geometryNonZero, mapping_geometry
[pyqgis] add misssing QgsSettings.setEnumValue also fix sections in enumValue and flagValue
2018-06-21 06:11:45 -04:00
from .additions.qgssettings import _qgssettings_enum_value, _qgssettings_set_enum_value, _qgssettings_flag_value
Python QgsSettingsEnum and Flag unified in QgsSettingsEnumFlag
2021-04-25 22:48:32 +02:00
from .additions.qgssettingsentry import PyQgsSettingsEntryEnumFlag
move additions from top __init__ to core.__init__
2018-05-16 11:29:28 -04:00
from .additions.qgstaskwrapper import QgsTaskWrapper
from .additions.readwritecontextentercategory import ReadWriteContextEnterCategory
Create RAII QgsScopedRuntimeProfile class and Python context manager to ease logging of runtime profiles. Now it's possible to do: with QgsRuntimeProfiler.profile('My operation'): # do something to automatically handle everything required to log the operation runtime
2020-05-18 14:22:16 +10:00
from .additions.runtimeprofiler import ScopedRuntimeProfileContextManager
[api][needs-docs] Allow registering PyQGIS using a nice decorator syntax This allows nice and simple, elegant construction of checks for Python. To use, Python based checks should use the decorator syntax: from qgis.core import check @check.register(type=QgsAbstractValidityCheck.TypeLayoutCheck) def my_layout_check(context, feedback): results = ... return results Or, a more complete example. This one throws a warning when attempting to export a layout with a map item set to the Web Mercator projection: @check.register(type=QgsAbstractValidityCheck.TypeLayoutCheck) def layout_map_crs_choice_check(context, feedback): layout = context.layout results = [] for i in layout.items(): if isinstance(i, QgsLayoutItemMap) and i.crs().authid() == 'EPSG:3857': res = QgsValidityCheckResult() res.type = QgsValidityCheckResult.Warning res.title='Map projection is misleading' res.detailedDescription='The projection for the map item {} is set to <i>Web Mercator (EPSG:3857)</i> which misrepresents areas and shapes. Consider using an appropriate local projection instead.'.format(i.displayName()) results.append(res) return results
2019-01-10 14:52:01 +10:00
from .additions.validitycheck import check
Add better __repr__ methods for QgsDateTimeRange, QgsDateRange
2021-03-23 14:12:06 +10:00
from .additions.ranges import datetime_range_repr, date_range_repr
[pyqgis] move qgis.core tricks to their own python file in additions folder this makes the code much easier to read
2018-05-14 11:30:27 -04:00
# Injections into classes
move additions from top __init__ to core.__init__
2018-05-16 11:29:28 -04:00
QgsFeature.__geo_interface__ = property(mapping_feature)
QgsGeometry.__bool__ = _geometryNonZero
QgsGeometry.__geo_interface__ = property(mapping_geometry)
QgsGeometry.__nonzero__ = _geometryNonZero
Output useful logging when running algorithms from toolbox Now outputs the input parameters, execution time, and results
2017-06-11 19:35:43 +10:00
QgsProcessingFeatureSourceDefinition.__repr__ = processing_source_repr
QgsProcessingOutputLayerDefinition.__repr__ = processing_output_layer_repr
move additions from top __init__ to core.__init__
2018-05-16 11:29:28 -04:00
QgsProject.blockDirtying = ProjectDirtyBlocker
QgsReadWriteContext.enterCategory = ReadWriteContextEnterCategory
Create RAII QgsScopedRuntimeProfile class and Python context manager to ease logging of runtime profiles. Now it's possible to do: with QgsRuntimeProfiler.profile('My operation'): # do something to automatically handle everything required to log the operation runtime
2020-05-18 14:22:16 +10:00
QgsRuntimeProfiler.profile = ScopedRuntimeProfileContextManager
[pyqgis] add QgsSettings.enumValue and flagValue to the bindings (#7024) * [pyqgis] add QgsSettings.enumValue and flagValue to the bindings these are done in pure Python since no implementation is possible in SIP there is a dirty hack for flags since QgsMapLayerProxyModel.Filters.__qualname__ returns 'Filters' and not 'QgsMapLayerProxyModel.Filters' * fix typo
2018-05-18 09:25:12 -08:00
QgsSettings.enumValue = _qgssettings_enum_value
[pyqgis] add misssing QgsSettings.setEnumValue also fix sections in enumValue and flagValue
2018-06-21 06:11:45 -04:00
QgsSettings.setEnumValue = _qgssettings_set_enum_value
[pyqgis] add QgsSettings.enumValue and flagValue to the bindings (#7024) * [pyqgis] add QgsSettings.enumValue and flagValue to the bindings these are done in pure Python since no implementation is possible in SIP there is a dirty hack for flags since QgsMapLayerProxyModel.Filters.__qualname__ returns 'Filters' and not 'QgsMapLayerProxyModel.Filters' * fix typo
2018-05-18 09:25:12 -08:00
QgsSettings.flagValue = _qgssettings_flag_value
move additions from top __init__ to core.__init__
2018-05-16 11:29:28 -04:00
QgsTask.fromFunction = fromFunction
Add better __repr__ methods for QgsDateTimeRange, QgsDateRange
2021-03-23 14:12:06 +10:00
QgsDateTimeRange.__repr__ = datetime_range_repr
QgsDateRange.__repr__ = date_range_repr
Patch QgsProviderMetadata in Python to avoid API break In C++ we do not support QgsProviderMetadata(key, description, createFunc) anymore, but for python code we can have a patched class that still supports createFunc. Why not keep the variant with createFunc in C++ as well? Because... SIP! With newly added virtual methods in QgsProviderMetadata, SIP started to generate a sip-specific subclass to handle derived classes in Python, however due to the variant with PyObject* and custom MethodCode it was getting confused about what constructors are available in C++ and failing to compile.
2019-06-21 18:27:36 +02:00
Python implementation for QgsSettingsEntryEnum/Flag and fixed docstrings
2021-04-07 14:02:08 +02:00
# Classes patched
Python QgsSettingsEnum and Flag unified in QgsSettingsEnumFlag
2021-04-25 22:48:32 +02:00
QgsSettingsEntryEnumFlag = PyQgsSettingsEntryEnumFlag
Python implementation for QgsSettingsEntryEnum/Flag and fixed docstrings
2021-04-07 14:02:08 +02:00
Patch QgsProviderMetadata in Python to avoid API break In C++ we do not support QgsProviderMetadata(key, description, createFunc) anymore, but for python code we can have a patched class that still supports createFunc. Why not keep the variant with createFunc in C++ as well? Because... SIP! With newly added virtual methods in QgsProviderMetadata, SIP started to generate a sip-specific subclass to handle derived classes in Python, however due to the variant with PyObject* and custom MethodCode it was getting confused about what constructors are available in C++ and failing to compile.
2019-06-21 18:27:36 +02:00
# Classes patched using a derived class
QgsProviderMetadata = PyProviderMetadata
Cleanup python code
2019-11-01 15:39:28 +01:00
# monkey patch deprecated enum values to maintain API
# TODO - remove for QGIS 4.0
Fix python startup
2021-10-21 12:13:07 +10:00
QgsMarkerLineSymbolLayer.Interval = Qgis.MarkerLinePlacement.Interval
QgsMarkerLineSymbolLayer.Vertex = Qgis.MarkerLinePlacement.Vertex
QgsMarkerLineSymbolLayer.LastVertex = Qgis.MarkerLinePlacement.LastVertex
QgsMarkerLineSymbolLayer.FirstVertex = Qgis.MarkerLinePlacement.FirstVertex
QgsMarkerLineSymbolLayer.CentralPoint = Qgis.MarkerLinePlacement.CentralPoint
QgsMarkerLineSymbolLayer.CurvePoint = Qgis.MarkerLinePlacement.CurvePoint
Cleanup python code
2019-11-01 15:39:28 +01:00
Condense duplicate enums
2021-10-21 12:34:05 +10:00
QgsRasterFillSymbolLayer.FillCoordinateMode = Qgis.SymbolCoordinateReference
QgsRasterFillSymbolLayer.Feature = Qgis.SymbolCoordinateReference.Feature
QgsRasterFillSymbolLayer.Viewport = Qgis.SymbolCoordinateReference.Viewport
QgsShapeburstFillSymbolLayer.ShapeburstColorType = Qgis.GradientColorSource
QgsShapeburstFillSymbolLayer.SimpleTwoColor = Qgis.GradientColorSource.SimpleTwoColor
QgsShapeburstFillSymbolLayer.ColorRamp = Qgis.GradientColorSource.ColorRamp
Move enums from QgsVectorLayer to Qgis, promote to enum classes, and fix redundant QgsVectorLayer.VertexMarkerType enum
2021-07-19 10:25:29 +10:00
QgsVectorLayer.VertexMarkerType = Qgis.VertexMarkerType
QgsVectorLayer.SemiTransparentCircle = Qgis.VertexMarkerType.SemiTransparentCircle
QgsVectorLayer.SemiTransparentCircle.is_monkey_patched = True
QgsVectorLayer.SemiTransparentCircle.__doc__ = "Semi-transparent circle marker"
QgsVectorLayer.Cross = Qgis.VertexMarkerType.Cross
QgsVectorLayer.Cross.is_monkey_patched = True
QgsVectorLayer.Cross.__doc__ = "Cross marker"
QgsVectorLayer.NoMarker = Qgis.VertexMarkerType.NoMarker
QgsVectorLayer.NoMarker.is_monkey_patched = True
QgsVectorLayer.NoMarker.__doc__ = "No marker"
Fix API break
2021-08-03 16:05:03 +10:00
QgsSymbol.RenderHints = Qgis.SymbolRenderHints
QgsSymbol.PreviewFlags = Qgis.SymbolPreviewFlags
QgsDataItem.Capabilities = Qgis.BrowserItemCapabilities
QgsGeometry.ValidityFlags = Qgis.GeometryValidityFlags
Cleanup python code
2019-11-01 15:39:28 +01:00
# Monkey patch static const "QgsDataProvider.SUBLAYER_SEPARATOR" which was removed for QGIS 3.12
QgsDataProvider.SUBLAYER_SEPARATOR = QgsDataProvider.sublayerSeparator()
# Monkey patch Qgis vars
Qgis.QGIS_VERSION = Qgis.version()
Qgis.QGIS_VERSION_INT = Qgis.versionInt()
Followup 1f3b039: fix wrong monkey patched var name
2019-11-05 10:34:29 +07:00
Qgis.QGIS_RELEASE_NAME = Qgis.releaseName()
Cleanup python code
2019-11-01 15:39:28 +01:00
Python fixes
2019-11-02 13:48:41 +01:00
GEOWKT = geoWkt()
PROJECT_SCALES = Qgis.defaultProjectScales()
GEOPROJ4 = geoProj4()
GEO_EPSG_CRS_AUTHID = geoEpsgCrsAuthId()
GEO_NONE = geoNone()
Reference in New Issue Copy Permalink