Coverage for C:\Program Files\QGIS 3.10\apps\qgis-ltr\python\qgis\core\__init__.py: 100%
134 statements
« prev ^ index » next coverage.py v7.2.3, created at 2023-04-10 14:40 +0900
1# -*- coding: utf-8 -*-
3"""
4***************************************************************************
5 __init__.py
6 ---------------------
7 Date : May 2014
8 Copyright : (C) 2014 by Nathan Woodrow
9 Email : woodrow dot nathan at gmail dot com
10***************************************************************************
11* *
12* This program is free software; you can redistribute it and/or modify *
13* it under the terms of the GNU General Public License as published by *
14* the Free Software Foundation; either version 2 of the License, or *
15* (at your option) any later version. *
16* *
17***************************************************************************
18"""
20__author__ = 'Nathan Woodrow'
21__date__ = 'May 2014'
22__copyright__ = '(C) 2014, Nathan Woodrow'
24from qgis.PyQt.QtCore import NULL
25from qgis._core import *
27from .additions.edit import edit, QgsEditError
28from .additions.fromfunction import fromFunction
29from .additions.markerlinesymbollayer import *
30from .additions.metaenum import metaEnumFromType, metaEnumFromValue
31from .additions.processing import processing_output_layer_repr, processing_source_repr
32from .additions.projectdirtyblocker import ProjectDirtyBlocker
33from .additions.providermetadata import PyProviderMetadata
34from .additions.qgsfeature import mapping_feature
35from .additions.qgsfunction import register_function, qgsfunction
36from .additions.qgsgeometry import _geometryNonZero, mapping_geometry
37from .additions.qgssettings import _qgssettings_enum_value, _qgssettings_set_enum_value, _qgssettings_flag_value
38from .additions.qgstaskwrapper import QgsTaskWrapper
39from .additions.readwritecontextentercategory import ReadWriteContextEnterCategory
40from .additions.validitycheck import check
42# Injections into classes
43QgsFeature.__geo_interface__ = property(mapping_feature)
44QgsGeometry.__bool__ = _geometryNonZero
45QgsGeometry.__geo_interface__ = property(mapping_geometry)
46QgsGeometry.__nonzero__ = _geometryNonZero
47QgsProcessingFeatureSourceDefinition.__repr__ = processing_source_repr
48QgsProcessingOutputLayerDefinition.__repr__ = processing_output_layer_repr
49QgsProject.blockDirtying = ProjectDirtyBlocker
50QgsReadWriteContext.enterCategory = ReadWriteContextEnterCategory
51QgsSettings.enumValue = _qgssettings_enum_value
52QgsSettings.setEnumValue = _qgssettings_set_enum_value
53QgsSettings.flagValue = _qgssettings_flag_value
54QgsTask.fromFunction = fromFunction
56# Classes patched using a derived class
57QgsProviderMetadata = PyProviderMetadata
58"""
59This folder is completed using sipify.pl script
60It is not aimed to be manually edited
61"""
62# The following has been generated automatically from src/core/qgis.h
63Qgis.PythonMacroMode.baseClass = Qgis
64# The following has been generated automatically from src/core/qgsabstractdatabaseproviderconnection.h
65QgsAbstractDatabaseProviderConnection.TableFlags.baseClass = QgsAbstractDatabaseProviderConnection
66TableFlags = QgsAbstractDatabaseProviderConnection # dirty hack since SIP seems to introduce the flags in module
67QgsAbstractDatabaseProviderConnection.Capability.baseClass = QgsAbstractDatabaseProviderConnection
68QgsAbstractDatabaseProviderConnection.Capabilities.baseClass = QgsAbstractDatabaseProviderConnection
69Capabilities = QgsAbstractDatabaseProviderConnection # dirty hack since SIP seems to introduce the flags in module
70# The following has been generated automatically from src/core/geometry/qgsabstractgeometry.h
71QgsAbstractGeometry.SegmentationToleranceType.baseClass = QgsAbstractGeometry
72# The following has been generated automatically from src/core/auth/qgsauthmanager.h
73QgsAuthManager.MessageLevel.baseClass = QgsAuthManager
74# The following has been generated automatically from src/core/qgsdataitem.h
75QgsDataItem.Type.baseClass = QgsDataItem
76QgsDataItem.State.baseClass = QgsDataItem
77QgsLayerItem.LayerType.baseClass = QgsLayerItem
78# The following has been generated automatically from src/core/qgsdatasourceuri.h
79QgsDataSourceUri.SslMode.baseClass = QgsDataSourceUri
80# The following has been generated automatically from src/core/qgsdefaultvalue.h
81QgsDefaultValue.__bool__ = lambda self: self.isValid()
82# The following has been generated automatically from src/core/dxf/qgsdxfexport.h
83# monkey patching scoped based enum
84QgsDxfExport.ExportResult.Success.__doc__ = "Successful export"
85QgsDxfExport.ExportResult.InvalidDeviceError.__doc__ = "Invalid device error"
86QgsDxfExport.ExportResult.DeviceNotWritableError.__doc__ = "Device not writable error"
87QgsDxfExport.ExportResult.EmptyExtentError.__doc__ = "Empty extent, no extent given and no extent could be derived from layers"
88QgsDxfExport.ExportResult.__doc__ = 'The result of an export as dxf operation\n\n.. versionadded:: 3.10.1\n\n' + '* ``Success``: ' + QgsDxfExport.ExportResult.Success.__doc__ + '\n' + '* ``InvalidDeviceError``: ' + QgsDxfExport.ExportResult.InvalidDeviceError.__doc__ + '\n' + '* ``DeviceNotWritableError``: ' + QgsDxfExport.ExportResult.DeviceNotWritableError.__doc__ + '\n' + '* ``EmptyExtentError``: ' + QgsDxfExport.ExportResult.EmptyExtentError.__doc__
89# --
90# The following has been generated automatically from src/core/qgseditformconfig.h
91QgsEditFormConfig.EditorLayout.baseClass = QgsEditFormConfig
92QgsEditFormConfig.FeatureFormSuppress.baseClass = QgsEditFormConfig
93QgsEditFormConfig.PythonInitCodeSource.baseClass = QgsEditFormConfig
94# The following has been generated automatically from src/core/qgsfieldproxymodel.h
95QgsFieldProxyModel.Filters.baseClass = QgsFieldProxyModel
96Filters = QgsFieldProxyModel # dirty hack since SIP seems to introduce the flags in module
97# The following has been generated automatically from src/core/geometry/qgsgeometry.h
98QgsGeometry.BufferSide.baseClass = QgsGeometry
99QgsGeometry.EndCapStyle.baseClass = QgsGeometry
100QgsGeometry.JoinStyle.baseClass = QgsGeometry
101# The following has been generated automatically from src/core/geocms/geonode/qgsgeonoderequest.h
102# monkey patching scoped based enum
103QgsGeoNodeRequest.BackendServer.Unknown.__doc__ = "Unknown backend"
104QgsGeoNodeRequest.BackendServer.QgisServer.__doc__ = "QGIS server used as backend"
105QgsGeoNodeRequest.BackendServer.Geoserver.__doc__ = "Geoserver used as backend"
106QgsGeoNodeRequest.BackendServer.__doc__ = 'GeoNode backend server type.\n\n' + '* ``Unknown``: ' + QgsGeoNodeRequest.BackendServer.Unknown.__doc__ + '\n' + '* ``QgisServer``: ' + QgsGeoNodeRequest.BackendServer.QgisServer.__doc__ + '\n' + '* ``Geoserver``: ' + QgsGeoNodeRequest.BackendServer.Geoserver.__doc__
107# --
108# The following has been generated automatically from src/core/layout/qgslayoutmanager.h
109QgsLayoutManagerProxyModel.Filters.baseClass = QgsLayoutManagerProxyModel
110Filters = QgsLayoutManagerProxyModel # dirty hack since SIP seems to introduce the flags in module
111# The following has been generated automatically from src/core/locator/qgslocatorfilter.h
112QgsLocatorFilter.Priority.baseClass = QgsLocatorFilter
113QgsLocatorFilter.Flags.baseClass = QgsLocatorFilter
114Flags = QgsLocatorFilter # dirty hack since SIP seems to introduce the flags in module
115# The following has been generated automatically from src/core/qgsmaplayer.h
116QgsMapLayer.LayerType = QgsMapLayerType
117# monkey patching scoped based enum
118QgsMapLayer.VectorLayer = QgsMapLayerType.VectorLayer
119QgsMapLayer.VectorLayer.__doc__ = ""
120QgsMapLayer.RasterLayer = QgsMapLayerType.RasterLayer
121QgsMapLayer.RasterLayer.__doc__ = ""
122QgsMapLayer.PluginLayer = QgsMapLayerType.PluginLayer
123QgsMapLayer.PluginLayer.__doc__ = ""
124QgsMapLayer.MeshLayer = QgsMapLayerType.MeshLayer
125QgsMapLayer.MeshLayer.__doc__ = "Added in 3.2"
126QgsMapLayerType.__doc__ = 'Types of layers that can be added to a map\n\n.. versionadded:: 3.8\n\n' + '* ``VectorLayer``: ' + QgsMapLayerType.VectorLayer.__doc__ + '\n' + '* ``RasterLayer``: ' + QgsMapLayerType.RasterLayer.__doc__ + '\n' + '* ``PluginLayer``: ' + QgsMapLayerType.PluginLayer.__doc__ + '\n' + '* ``MeshLayer``: ' + QgsMapLayerType.MeshLayer.__doc__
127# --
128QgsMapLayer.LayerFlag.baseClass = QgsMapLayer
129QgsMapLayer.LayerFlags.baseClass = QgsMapLayer
130LayerFlags = QgsMapLayer # dirty hack since SIP seems to introduce the flags in module
131QgsMapLayer.StyleCategory.baseClass = QgsMapLayer
132QgsMapLayer.StyleCategories.baseClass = QgsMapLayer
133StyleCategories = QgsMapLayer # dirty hack since SIP seems to introduce the flags in module
134# The following has been generated automatically from src/core/qgsmaplayermodel.h
135QgsMapLayerModel.ItemDataRole.baseClass = QgsMapLayerModel
136# The following has been generated automatically from src/core/qgsmaplayerproxymodel.h
137QgsMapLayerProxyModel.Filters.baseClass = QgsMapLayerProxyModel
138Filters = QgsMapLayerProxyModel # dirty hack since SIP seems to introduce the flags in module
139# The following has been generated automatically from src/core/qgsnetworkcontentfetcherregistry.h
140QgsNetworkContentFetcherRegistry.FetchingMode.baseClass = QgsNetworkContentFetcherRegistry
141# The following has been generated automatically from src/core/processing/qgsprocessingutils.h
142# monkey patching scoped based enum
143QgsProcessingUtils.UnknownType = QgsProcessingUtils.LayerHint.UnknownType
144QgsProcessingUtils.LayerHint.UnknownType.__doc__ = "Unknown layer type"
145QgsProcessingUtils.Vector = QgsProcessingUtils.LayerHint.Vector
146QgsProcessingUtils.LayerHint.Vector.__doc__ = "Vector layer type"
147QgsProcessingUtils.Raster = QgsProcessingUtils.LayerHint.Raster
148QgsProcessingUtils.LayerHint.Raster.__doc__ = "Raster layer type"
149QgsProcessingUtils.Mesh = QgsProcessingUtils.LayerHint.Mesh
150QgsProcessingUtils.LayerHint.Mesh.__doc__ = "Mesh layer type \since QGIS 3.6"
151QgsProcessingUtils.LayerHint.__doc__ = 'Layer type hints.\n\n.. versionadded:: 3.4\n\n' + '* ``UnknownType``: ' + QgsProcessingUtils.LayerHint.UnknownType.__doc__ + '\n' + '* ``Vector``: ' + QgsProcessingUtils.LayerHint.Vector.__doc__ + '\n' + '* ``Raster``: ' + QgsProcessingUtils.LayerHint.Raster.__doc__ + '\n' + '* ``Mesh``: ' + QgsProcessingUtils.LayerHint.Mesh.__doc__
152# --
153# The following has been generated automatically from src/core/qgsprovidermetadata.h
154# monkey patching scoped based enum
155QgsProviderMetadata.FilterType.FilterVector.__doc__ = ""
156QgsProviderMetadata.FilterType.FilterRaster.__doc__ = ""
157QgsProviderMetadata.FilterType.FilterMesh.__doc__ = ""
158QgsProviderMetadata.FilterType.FilterMeshDataset.__doc__ = ""
159QgsProviderMetadata.FilterType.__doc__ = 'Type of file filters\n\n.. versionadded:: 3.10\n\n' + '* ``FilterVector``: ' + QgsProviderMetadata.FilterType.FilterVector.__doc__ + '\n' + '* ``FilterRaster``: ' + QgsProviderMetadata.FilterType.FilterRaster.__doc__ + '\n' + '* ``FilterMesh``: ' + QgsProviderMetadata.FilterType.FilterMesh.__doc__ + '\n' + '* ``FilterMeshDataset``: ' + QgsProviderMetadata.FilterType.FilterMeshDataset.__doc__
160# --
161# The following has been generated automatically from src/core/raster/qgsrasterprojector.h
162QgsRasterProjector.Precision.baseClass = QgsRasterProjector
163# The following has been generated automatically from src/core/qgssnappingconfig.h
164QgsSnappingConfig.SnappingMode.baseClass = QgsSnappingConfig
165QgsSnappingConfig.SnappingType.baseClass = QgsSnappingConfig
166# The following has been generated automatically from src/core/symbology/qgsstyleentityvisitor.h
167# monkey patching scoped based enum
168QgsStyleEntityVisitorInterface.NodeType.Project.__doc__ = "QGIS Project node"
169QgsStyleEntityVisitorInterface.NodeType.Layer.__doc__ = "Map layer"
170QgsStyleEntityVisitorInterface.NodeType.SymbolRule.__doc__ = "Rule based symbology or label child rule"
171QgsStyleEntityVisitorInterface.NodeType.Layouts.__doc__ = "Layout collection"
172QgsStyleEntityVisitorInterface.NodeType.PrintLayout.__doc__ = "An individual print layout"
173QgsStyleEntityVisitorInterface.NodeType.LayoutItem.__doc__ = "Individual item in a print layout"
174QgsStyleEntityVisitorInterface.NodeType.Report.__doc__ = "A QGIS print report"
175QgsStyleEntityVisitorInterface.NodeType.ReportHeader.__doc__ = "Report header section"
176QgsStyleEntityVisitorInterface.NodeType.ReportFooter.__doc__ = "Report footer section"
177QgsStyleEntityVisitorInterface.NodeType.ReportSection.__doc__ = "Report sub section"
178QgsStyleEntityVisitorInterface.NodeType.Annotations.__doc__ = "Annotations collection"
179QgsStyleEntityVisitorInterface.NodeType.Annotation.__doc__ = "An individual annotation"
180QgsStyleEntityVisitorInterface.NodeType.__doc__ = 'Describes the types of nodes which may be visited by the visitor.\n\n' + '* ``Project``: ' + QgsStyleEntityVisitorInterface.NodeType.Project.__doc__ + '\n' + '* ``Layer``: ' + QgsStyleEntityVisitorInterface.NodeType.Layer.__doc__ + '\n' + '* ``SymbolRule``: ' + QgsStyleEntityVisitorInterface.NodeType.SymbolRule.__doc__ + '\n' + '* ``Layouts``: ' + QgsStyleEntityVisitorInterface.NodeType.Layouts.__doc__ + '\n' + '* ``PrintLayout``: ' + QgsStyleEntityVisitorInterface.NodeType.PrintLayout.__doc__ + '\n' + '* ``LayoutItem``: ' + QgsStyleEntityVisitorInterface.NodeType.LayoutItem.__doc__ + '\n' + '* ``Report``: ' + QgsStyleEntityVisitorInterface.NodeType.Report.__doc__ + '\n' + '* ``ReportHeader``: ' + QgsStyleEntityVisitorInterface.NodeType.ReportHeader.__doc__ + '\n' + '* ``ReportFooter``: ' + QgsStyleEntityVisitorInterface.NodeType.ReportFooter.__doc__ + '\n' + '* ``ReportSection``: ' + QgsStyleEntityVisitorInterface.NodeType.ReportSection.__doc__ + '\n' + '* ``Annotations``: ' + QgsStyleEntityVisitorInterface.NodeType.Annotations.__doc__ + '\n' + '* ``Annotation``: ' + QgsStyleEntityVisitorInterface.NodeType.Annotation.__doc__
181# --
182# The following has been generated automatically from src/core/qgstaskmanager.h
183QgsTask.TaskStatus.baseClass = QgsTask
184# The following has been generated automatically from src/core/qgstolerance.h
185QgsTolerance.UnitType.baseClass = QgsTolerance
186# The following has been generated automatically from src/core/qgsunittypes.h
187QgsUnitTypes.SystemOfMeasurement.baseClass = QgsUnitTypes
188QgsUnitTypes.DistanceUnit.baseClass = QgsUnitTypes
189QgsUnitTypes.AreaUnit.baseClass = QgsUnitTypes
190QgsUnitTypes.VolumeUnit.baseClass = QgsUnitTypes
191QgsUnitTypes.AngleUnit.baseClass = QgsUnitTypes
192QgsUnitTypes.RenderUnit.baseClass = QgsUnitTypes
193QgsUnitTypes.LayoutUnit.baseClass = QgsUnitTypes
194# The following has been generated automatically from src/core/qgsvectorlayerserverproperties.h
195QgsVectorLayerServerProperties.PredefinedWmsDimensionName.baseClass = QgsVectorLayerServerProperties
196# The following has been generated automatically from src/core/qgsvectorsimplifymethod.h
197QgsVectorSimplifyMethod.SimplifyHint.baseClass = QgsVectorSimplifyMethod
198QgsVectorSimplifyMethod.SimplifyHints.baseClass = QgsVectorSimplifyMethod
199SimplifyHints = QgsVectorSimplifyMethod # dirty hack since SIP seems to introduce the flags in module
200QgsVectorSimplifyMethod.SimplifyAlgorithm.baseClass = QgsVectorSimplifyMethod
201# The following has been generated automatically from src/core/geometry/qgswkbtypes.h
202QgsWkbTypes.Type.baseClass = QgsWkbTypes
203QgsWkbTypes.GeometryType.baseClass = QgsWkbTypes