:tocdepth: 3

:py:mod:`shapefile`
===================

.. py:module:: shapefile

.. autoapi-nested-parse::

   Exporter for the ESRI Shapefile format.



**Source code:** :source:`shapefile<gws/plugin/exporter/shapefile/__init__.py>`



Package Contents
----------------



.. py:class:: Config


   Bases: :py:obj:`gws.base.exporter.Config`

   Shapefile Exporter configuration.


.. py:function:: export_features(features: list[gws.Feature], target_path: str, er: gws.ExportResult, notify: Optional[Callable] = None)

   Export features to a shapefile.

   :param features: list of features to export (must have the same model)
   :param target_path: path to the output shapefile
   :param er: export result object to update with progress and errors
   :param notify: optional callback to notify about progress, called with 'feature' argument


.. py:class:: Object


   Bases: :py:obj:`gws.base.exporter.Object`

   .. py:attribute:: supportsRaster
      :value: False


   .. py:attribute:: supportsVector
      :value: True


   .. py:method:: run(ea)


.. py:class:: Props


   Bases: :py:obj:`gws.base.exporter.Props`

   Shapefile Exporter properties.


.. py:function:: run_export(ea: gws.ExportArgs) -> gws.ExportResult

   Run the export for multiple features, make a zip archive with a shapefile per model.