generators

`automaps.generators.base` #

This module contains the base class for custom MapGenerators.

`MapGenerator (ABC)` #

This is the base class for concrete MapGenerators.

Creating concrete subclasses is part of the configuration of autoMaps projects and described in the documentation.

Attributes:

Name	Type	Description
`name`	`str`	The name of the generator. Must be set on declaration of each concrete subclass.
`steps`	`OrderedDict[str, Step]`	The processing steps. Must be set on declaration of each concrete subclass (using _set_steps()). The dictionary keys are the names of the steps (which will be shown in the UI). The dictionary values are `Step` objects (`NamedTuples`).
`data_to_exclude_from_filename`	`List[str]`	The entries in the data dictionary, which won't be used to create the export filename. Don't overwrite this!

Source code in automaps/generators/base.py

class MapGenerator(ABC):
    """This is the base class for concrete MapGenerators.

    Creating concrete subclasses is part of the configuration of autoMaps projects and
    described in the documentation.

    Attributes:
        name (str): The name of the generator. Must be set on declaration of each
            concrete subclass.
        steps (OrderedDict[str, Step]): The processing steps. Must be set on declaration
            of each concrete subclass (using _set_steps()). The dictionary keys are the
            names of the steps (which will be shown in the UI). The dictionary values
            are `Step` objects (`NamedTuples`).
        data_to_exclude_from_filename (List[str]): The entries in the data dictionary,
            which won't be used to create the export filename. Don't overwrite this!
    """

    name: str
    steps: OrderedDict[str, Step]
    data_to_exclude_from_filename: List[str] = [
        "selectors_to_exclude_from_filename",
        "maptype_dict_key",
        "step",
        "job_uuid",
        "print_layout",
        "!FILEFORMAT!",
        "event",
    ]

    def __init__(
        self,
        data: dict,
        basepath_fileserver: str,
        print_layout: str,
        step_data: StepData,
        job_uuid: str,
        default_file_format: str = "pdf",
    ):
        """Initialize MapGenerator.

        Args:
            data (dict): The data dictionary, containing all the necessary information
                to create a map of a specific type. Normally, the data dictionary is
                generated by the frontend, depending on the user input.
            basepath_fileserver (str): The path where the map exports shall be stored.
            print_layout (str): The name of the QGIS print layout for a specific map
                type.
            step_data (StepData): Data to pass between the individual processing steps.
            job_uuid (str): The uuid of a specific map creation job.
            default_file_format (str, optional): The export file format, if the data
                dictionary does not contain the key '!FILEFORMAT!'. Defaults to "pdf".

        Raises:
            ValueError: If desired `default_file_format` is not supported.
        """
        self.data = data
        self.basepath_fileserver = basepath_fileserver
        self.print_layout = print_layout
        self.step_data = step_data
        self.job_uuid = job_uuid
        self.file_format = self.data.pop("!FILEFORMAT!", default_file_format).lower()
        if self.file_format not in ["pdf", "png", "svg"]:
            raise ValueError(f"Unsupported export file format: {self.file_format}")
        self.step_data.message_to_client["filename"] = self.filename
        try:
            self.step_data.project  # type: ignore
        except AttributeError:
            self.step_data.project = self._get_project()  # type: ignore
        self.step_data.layout = self._get_print_layout()  # type: ignore

        self._set_steps()
        self.total_weight: float = sum([s.weight for s in self.steps.values()])

    @property
    def filename(self) -> str:
        """The full filename for the export, including path.

        The filename is constructed depending on the basepath of the fileserver,
        the job uuid, the name of the generator, and the desired file format. Values
        are excluded depending on the project configuration and
        `self.data_to_exclude_from_filename`. Some characters are replaced to ensure
        proper file paths as output.

        Returns:
            str: _description_
        """
        data = copy(self.data)
        data_keys_to_pop = (
            data.get("selectors_to_exclude_from_filename", [])
            + [x for x in data.keys() if " OPTIONS" in x]
            + self.data_to_exclude_from_filename
        )
        for key in data_keys_to_pop:
            data.pop(key, None)
        return os.path.join(
            self.basepath_fileserver,
            f"{self.job_uuid}_"
            f"{self.name}_"
            f"{'_'.join(str(x) for x in data.values() if x)}".replace(" ", "_")
            .replace(".", "_")
            .replace("/", "_")
            + f".{self.file_format}",
        )

    @abstractmethod
    def _set_steps(self):
        """Defines the processing steps.

        This is done by assigning an `OrderedDict[str, StepData]` to `self.steps`

        The dictionary keys are the names of the steps (which will be shown in the UI).
        The dictionary values are `Step` objects (`NamedTuples`).
        """
        pass

    def run_step(self, name: str) -> StepData:
        """Runs a single processin step.

        Args:
            name (str): The name of the step to run, as defined in `self.steps`.

        Returns:
            StepData: The data which shall be passed to the next processing step.
        """
        self.steps[name].func()
        self.step_data.message_to_client["rel_weight"] = (
            self.steps[name].weight / self.total_weight
        )
        return self.step_data

    def _get_project(self) -> QgsProject:
        """Gets the QGIS project associated with a specific generator.

        Returns:
            QgsProject: The associated QGIS project.
        """
        return get_project()

    def _init_layers(self):
        """Initializes all layers.

        This includes removing all filter expressions (if applicable) and setting all
        layers to invisible."""
        for lyr in self._get_all_map_layers():
            try:
                lyr.setSubsetString("")
            except AttributeError:
                pass
        for node in self.step_data.project.layerTreeRoot().children():
            if isinstance(node, QgsLayerTreeLayer):
                node.setItemVisibilityCheckedRecursive(False)

    def _set_project_variable(self, var_name: str, var_value: Any):
        """Sets a user defined variable in the associated QGIS project.

        Args:
            var_name (str): The name of the variable.
            var_value (Any): The value of the variable.
        """
        set_project_variable(self.step_data.project, var_name, var_value)  # type: ignore

    def _get_print_layout(self) -> QgsPrintLayout:
        """Returns the configured or user selected QGIS print layout.

        Returns:
            QgsPrintLayout: The desired print layout.
        """
        return get_layout_by_name(self.step_data.project, self.print_layout)  # type: ignore

    def _get_map_layer(self, layer_name: str) -> QgsMapLayer:
        """Returns the QGIS map layer.

        Args:
            layer_name (str): The name of the map layer.

        Raises:
            ValueError: If layer cannot be found.
            ValueError: If layer name is ambiguous.

        Returns:
            QgsMapLayer: The desired QGIS map layer.
        """
        layers = self.step_data.project.mapLayersByName(layer_name)  # type: ignore
        if len(layers) == 0:
            raise ValueError(f"Could not find layer {layer_name}.")
        elif len(layers) > 1:
            raise ValueError(
                f"Found multiple ({len(layers)}) layers with name {layer_name}."
            )
        return layers[0]

    def _get_all_map_layers(self) -> List[QgsMapLayer]:
        """Returns all QGIS map layers of the associated QGIS project.

        Returns:
            List[QgsMapLayer]: The map layers.
        """
        layers = list(self.step_data.project.mapLayers().values())  # type: ignore
        return layers

    def _set_map_layer_filter_expression(self, layer_name: str, filter_expr: str):
        """Sets the filter expression for a QGIS map layer.

        Args:
            layer_name (str): The name of the map layer.
            filter_expr (str): The filter expression.
        """
        lyr = self._get_map_layer(layer_name)
        filter_expr = filter_expr.replace("[", "(").replace("]", ")")
        lyr.setSubsetString(filter_expr)

    def _remove_map_layer_filter_expression(self, layer_name: str):
        """Removes the filter expression for a QGIS map layer.

        Args:
            layer_name (str): The name of the map layer.
        """
        lyr = self._get_map_layer(layer_name)
        lyr.setSubsetString("")

    def _set_map_layer_visibility(
        self, layer_names: Union[str, List[str]], is_visible: bool
    ):
        """Sets the visibility of one ore more QIGS map layers.

        Args:
            layer_names (Union[str, List[str]]): If `str`: The name of the layer. If
                `List[str]`: The names of the layers.
            is_visible (bool): `True`, if layer(s) shall be visible, `False` otherwise.
        """
        if isinstance(layer_names, str):
            layer_names = [layer_names]
        for layer_name in layer_names:
            layer = self._get_map_layer(layer_name)
            root = self.step_data.project.layerTreeRoot()  # type: ignore
            node = root.findLayer(layer.id())
            if node:
                node.setItemVisibilityChecked(is_visible)

    def _set_layer_labels_visibility(self, layer_name: str, is_visible: bool):
        """Sets the visibility of the labels of a QGIS map layer.

        Args:
            layer_name (str): The name of the layer.
            is_visible (bool): `True`, if the labels shall be visible, `False`
                otherwise.
        """
        lyr = self._get_map_layer(layer_name)
        lyr.setLabelsEnabled(is_visible)

    def _set_layer_style(self, layer_name: str, style_name: str):
        """Switches the style of a QGIS map layer.

        Args:
            layer_name (str): The name of the layer.
            style_name (str): The name of the style.
        """
        lyr = self._get_map_layer(layer_name)
        lyr.styleManager().setCurrentStyle(style_name)

    def _zoom_map_to_layer_extent(
        self,
        map_name: str,
        layer: QgsMapLayer,
        buffer: Optional[float] = None,
        relative_buffer: Optional[float] = None,
    ):
        """Centers a map to the given layer and zooms to its extent. The extent can be
        increased by adding a buffer.

        Args:
            map_name (str): Name of the map to modify as defined in the associated
                print layout.
            layer (QgsMapLayer): Layer to get extent from
            buffer (float, optional): Absolute value (in map units) of the buffer.
                Defaults to None.
            relative_buffer (float, optional): Relative value of the buffer. To increase
                the map extent by 10 %, use the value 0.1. Defaults to None.
        """
        extent = layer.extent()
        if buffer is not None:
            extent = extent.buffered(buffer)
        self.step_data.layout.itemById(map_name).zoomToExtent(extent)  # type: ignore
        if relative_buffer is not None:
            scale_padded = self.step_data.layout.itemById(map_name).scale() * (
                1 + relative_buffer
            )
            self.step_data.layout.itemById(map_name).setScale(scale_padded)

    def _scale_map_to_layer_extent(
        self,
        map_name: str,
        layer: QgsMapLayer,
        scale: float = 1000.0,
    ):
        """Centers a map to the given layer and zooms to a fixed scale.

        Args:
            map_name (str): The name of the map as defined in the print layout.
            layer (QgsMapLayer): The name of the layer.
            scale (float, optional): The scale to zoom to. Defaults to 1000.0.
        """
        # buffer needed if only 1 point in layer
        buffered_layer_extent = layer.extent().buffered(1)
        self.step_data.layout.itemById(map_name).zoomToExtent(buffered_layer_extent)  # type: ignore
        self.step_data.layout.itemById(map_name).setScale(scale)  # type: ignore

    def _export_print_layout(self):
        """Exports the print layout."""
        export_layout(self.step_data.layout, self.filename, self.file_format)

    def _remove_legend_node(self, layer_name: str):
        """Removes the legend entry of a (visible) layer.

        Args:
            layer_name (str): The name of the layer.
        """
        legend = next(
            item
            for item in self.step_data.layout.items()
            if isinstance(item, QgsLayoutItemLegend)
        )
        model = legend.model()
        layer = self._get_map_layer(layer_name)
        layerNode = model.rootGroup().findLayer(layer)
        QgsMapLayerLegendUtils.setLegendNodeOrder(layerNode, [])
        model.refreshLayerLegend(layerNode)

`filename: str` `property` `readonly` #

The full filename for the export, including path.

The filename is constructed depending on the basepath of the fileserver, the job uuid, the name of the generator, and the desired file format. Values are excluded depending on the project configuration and self.data_to_exclude_from_filename. Some characters are replaced to ensure proper file paths as output.

Returns:

Type	Description
`str`	description

`init(self, data, basepath_fileserver, print_layout, step_data, job_uuid, default_file_format='pdf')` `special` #

Initialize MapGenerator.

Parameters:

Name	Type	Description	Default
`data`	`dict`	The data dictionary, containing all the necessary information to create a map of a specific type. Normally, the data dictionary is generated by the frontend, depending on the user input.	required
`basepath_fileserver`	`str`	The path where the map exports shall be stored.	required
`print_layout`	`str`	The name of the QGIS print layout for a specific map type.	required
`step_data`	`StepData`	Data to pass between the individual processing steps.	required
`job_uuid`	`str`	The uuid of a specific map creation job.	required
`default_file_format`	`str`	The export file format, if the data dictionary does not contain the key '!FILEFORMAT!'. Defaults to "pdf".	`'pdf'`

Exceptions:

Type	Description
`ValueError`	If desired `default_file_format` is not supported.

Source code in automaps/generators/base.py

def __init__(
    self,
    data: dict,
    basepath_fileserver: str,
    print_layout: str,
    step_data: StepData,
    job_uuid: str,
    default_file_format: str = "pdf",
):
    """Initialize MapGenerator.

    Args:
        data (dict): The data dictionary, containing all the necessary information
            to create a map of a specific type. Normally, the data dictionary is
            generated by the frontend, depending on the user input.
        basepath_fileserver (str): The path where the map exports shall be stored.
        print_layout (str): The name of the QGIS print layout for a specific map
            type.
        step_data (StepData): Data to pass between the individual processing steps.
        job_uuid (str): The uuid of a specific map creation job.
        default_file_format (str, optional): The export file format, if the data
            dictionary does not contain the key '!FILEFORMAT!'. Defaults to "pdf".

    Raises:
        ValueError: If desired `default_file_format` is not supported.
    """
    self.data = data
    self.basepath_fileserver = basepath_fileserver
    self.print_layout = print_layout
    self.step_data = step_data
    self.job_uuid = job_uuid
    self.file_format = self.data.pop("!FILEFORMAT!", default_file_format).lower()
    if self.file_format not in ["pdf", "png", "svg"]:
        raise ValueError(f"Unsupported export file format: {self.file_format}")
    self.step_data.message_to_client["filename"] = self.filename
    try:
        self.step_data.project  # type: ignore
    except AttributeError:
        self.step_data.project = self._get_project()  # type: ignore
    self.step_data.layout = self._get_print_layout()  # type: ignore

    self._set_steps()
    self.total_weight: float = sum([s.weight for s in self.steps.values()])

`_export_print_layout(self)` `private` #

Exports the print layout.

Source code in automaps/generators/base.py

def _export_print_layout(self):
    """Exports the print layout."""
    export_layout(self.step_data.layout, self.filename, self.file_format)

`_get_all_map_layers(self)` `private` #

Returns all QGIS map layers of the associated QGIS project.

Returns:

Type	Description
`List[QgsMapLayer]`	The map layers.

Source code in automaps/generators/base.py

def _get_all_map_layers(self) -> List[QgsMapLayer]:
    """Returns all QGIS map layers of the associated QGIS project.

    Returns:
        List[QgsMapLayer]: The map layers.
    """
    layers = list(self.step_data.project.mapLayers().values())  # type: ignore
    return layers

`_get_map_layer(self, layer_name)` `private` #

Returns the QGIS map layer.

Parameters:

Name	Type	Description	Default
`layer_name`	`str`	The name of the map layer.	required

Exceptions:

Type	Description
`ValueError`	If layer cannot be found.
`ValueError`	If layer name is ambiguous.

Returns:

Type	Description
`QgsMapLayer`	The desired QGIS map layer.

Source code in automaps/generators/base.py

def _get_map_layer(self, layer_name: str) -> QgsMapLayer:
    """Returns the QGIS map layer.

    Args:
        layer_name (str): The name of the map layer.

    Raises:
        ValueError: If layer cannot be found.
        ValueError: If layer name is ambiguous.

    Returns:
        QgsMapLayer: The desired QGIS map layer.
    """
    layers = self.step_data.project.mapLayersByName(layer_name)  # type: ignore
    if len(layers) == 0:
        raise ValueError(f"Could not find layer {layer_name}.")
    elif len(layers) > 1:
        raise ValueError(
            f"Found multiple ({len(layers)}) layers with name {layer_name}."
        )
    return layers[0]

`_get_print_layout(self)` `private` #

Returns the configured or user selected QGIS print layout.

Returns:

Type	Description
`QgsPrintLayout`	The desired print layout.

Source code in automaps/generators/base.py

def _get_print_layout(self) -> QgsPrintLayout:
    """Returns the configured or user selected QGIS print layout.

    Returns:
        QgsPrintLayout: The desired print layout.
    """
    return get_layout_by_name(self.step_data.project, self.print_layout)  # type: ignore

`_get_project(self)` `private` #

Gets the QGIS project associated with a specific generator.

Returns:

Type	Description
`QgsProject`	The associated QGIS project.

Source code in automaps/generators/base.py

def _get_project(self) -> QgsProject:
    """Gets the QGIS project associated with a specific generator.

    Returns:
        QgsProject: The associated QGIS project.
    """
    return get_project()

`_init_layers(self)` `private` #

Initializes all layers.

This includes removing all filter expressions (if applicable) and setting all layers to invisible.

Source code in automaps/generators/base.py

def _init_layers(self):
    """Initializes all layers.

    This includes removing all filter expressions (if applicable) and setting all
    layers to invisible."""
    for lyr in self._get_all_map_layers():
        try:
            lyr.setSubsetString("")
        except AttributeError:
            pass
    for node in self.step_data.project.layerTreeRoot().children():
        if isinstance(node, QgsLayerTreeLayer):
            node.setItemVisibilityCheckedRecursive(False)

`_remove_legend_node(self, layer_name)` `private` #

Removes the legend entry of a (visible) layer.

Parameters:

Name	Type	Description	Default
`layer_name`	`str`	The name of the layer.	required

Source code in automaps/generators/base.py

def _remove_legend_node(self, layer_name: str):
    """Removes the legend entry of a (visible) layer.

    Args:
        layer_name (str): The name of the layer.
    """
    legend = next(
        item
        for item in self.step_data.layout.items()
        if isinstance(item, QgsLayoutItemLegend)
    )
    model = legend.model()
    layer = self._get_map_layer(layer_name)
    layerNode = model.rootGroup().findLayer(layer)
    QgsMapLayerLegendUtils.setLegendNodeOrder(layerNode, [])
    model.refreshLayerLegend(layerNode)

`_remove_map_layer_filter_expression(self, layer_name)` `private` #

Removes the filter expression for a QGIS map layer.

Parameters:

Name	Type	Description	Default
`layer_name`	`str`	The name of the map layer.	required

Source code in automaps/generators/base.py

def _remove_map_layer_filter_expression(self, layer_name: str):
    """Removes the filter expression for a QGIS map layer.

    Args:
        layer_name (str): The name of the map layer.
    """
    lyr = self._get_map_layer(layer_name)
    lyr.setSubsetString("")

`_scale_map_to_layer_extent(self, map_name, layer, scale=1000.0)` `private` #

Centers a map to the given layer and zooms to a fixed scale.

Parameters:

Name	Type	Description	Default
`map_name`	`str`	The name of the map as defined in the print layout.	required
`layer`	`QgsMapLayer`	The name of the layer.	required
`scale`	`float`	The scale to zoom to. Defaults to 1000.0.	`1000.0`

Source code in automaps/generators/base.py

def _scale_map_to_layer_extent(
    self,
    map_name: str,
    layer: QgsMapLayer,
    scale: float = 1000.0,
):
    """Centers a map to the given layer and zooms to a fixed scale.

    Args:
        map_name (str): The name of the map as defined in the print layout.
        layer (QgsMapLayer): The name of the layer.
        scale (float, optional): The scale to zoom to. Defaults to 1000.0.
    """
    # buffer needed if only 1 point in layer
    buffered_layer_extent = layer.extent().buffered(1)
    self.step_data.layout.itemById(map_name).zoomToExtent(buffered_layer_extent)  # type: ignore
    self.step_data.layout.itemById(map_name).setScale(scale)  # type: ignore

`_set_layer_labels_visibility(self, layer_name, is_visible)` `private` #

Sets the visibility of the labels of a QGIS map layer.

Parameters:

Name	Type	Description	Default
`layer_name`	`str`	The name of the layer.	required
`is_visible`	`bool`	`True`, if the labels shall be visible, `False` otherwise.	required

Source code in automaps/generators/base.py

def _set_layer_labels_visibility(self, layer_name: str, is_visible: bool):
    """Sets the visibility of the labels of a QGIS map layer.

    Args:
        layer_name (str): The name of the layer.
        is_visible (bool): `True`, if the labels shall be visible, `False`
            otherwise.
    """
    lyr = self._get_map_layer(layer_name)
    lyr.setLabelsEnabled(is_visible)

`_set_layer_style(self, layer_name, style_name)` `private` #

Switches the style of a QGIS map layer.

Parameters:

Name	Type	Description	Default
`layer_name`	`str`	The name of the layer.	required
`style_name`	`str`	The name of the style.	required

Source code in automaps/generators/base.py

def _set_layer_style(self, layer_name: str, style_name: str):
    """Switches the style of a QGIS map layer.

    Args:
        layer_name (str): The name of the layer.
        style_name (str): The name of the style.
    """
    lyr = self._get_map_layer(layer_name)
    lyr.styleManager().setCurrentStyle(style_name)

`_set_map_layer_filter_expression(self, layer_name, filter_expr)` `private` #

Sets the filter expression for a QGIS map layer.

Parameters:

Name	Type	Description	Default
`layer_name`	`str`	The name of the map layer.	required
`filter_expr`	`str`	The filter expression.	required

Source code in automaps/generators/base.py

def _set_map_layer_filter_expression(self, layer_name: str, filter_expr: str):
    """Sets the filter expression for a QGIS map layer.

    Args:
        layer_name (str): The name of the map layer.
        filter_expr (str): The filter expression.
    """
    lyr = self._get_map_layer(layer_name)
    filter_expr = filter_expr.replace("[", "(").replace("]", ")")
    lyr.setSubsetString(filter_expr)

`_set_map_layer_visibility(self, layer_names, is_visible)` `private` #

Sets the visibility of one ore more QIGS map layers.

Parameters:

Name	Type	Description	Default
`layer_names`	`Union[str, List[str]]`	If `str`: The name of the layer. If `List[str]`: The names of the layers.	required
`is_visible`	`bool`	`True`, if layer(s) shall be visible, `False` otherwise.	required

Source code in automaps/generators/base.py

def _set_map_layer_visibility(
    self, layer_names: Union[str, List[str]], is_visible: bool
):
    """Sets the visibility of one ore more QIGS map layers.

    Args:
        layer_names (Union[str, List[str]]): If `str`: The name of the layer. If
            `List[str]`: The names of the layers.
        is_visible (bool): `True`, if layer(s) shall be visible, `False` otherwise.
    """
    if isinstance(layer_names, str):
        layer_names = [layer_names]
    for layer_name in layer_names:
        layer = self._get_map_layer(layer_name)
        root = self.step_data.project.layerTreeRoot()  # type: ignore
        node = root.findLayer(layer.id())
        if node:
            node.setItemVisibilityChecked(is_visible)

`_set_project_variable(self, var_name, var_value)` `private` #

Sets a user defined variable in the associated QGIS project.

Parameters:

Name	Type	Description	Default
`var_name`	`str`	The name of the variable.	required
`var_value`	`Any`	The value of the variable.	required

Source code in automaps/generators/base.py

def _set_project_variable(self, var_name: str, var_value: Any):
    """Sets a user defined variable in the associated QGIS project.

    Args:
        var_name (str): The name of the variable.
        var_value (Any): The value of the variable.
    """
    set_project_variable(self.step_data.project, var_name, var_value)  # type: ignore

`_set_steps(self)` `private` #

Defines the processing steps.

This is done by assigning an OrderedDict[str, StepData] to self.steps

The dictionary keys are the names of the steps (which will be shown in the UI). The dictionary values are Step objects (NamedTuples).

Source code in automaps/generators/base.py

@abstractmethod
def _set_steps(self):
    """Defines the processing steps.

    This is done by assigning an `OrderedDict[str, StepData]` to `self.steps`

    The dictionary keys are the names of the steps (which will be shown in the UI).
    The dictionary values are `Step` objects (`NamedTuples`).
    """
    pass

`_zoom_map_to_layer_extent(self, map_name, layer, buffer=None, relative_buffer=None)` `private` #

Centers a map to the given layer and zooms to its extent. The extent can be increased by adding a buffer.

Parameters:

Name	Type	Description	Default
`map_name`	`str`	Name of the map to modify as defined in the associated print layout.	required
`layer`	`QgsMapLayer`	Layer to get extent from	required
`buffer`	`float`	Absolute value (in map units) of the buffer. Defaults to None.	`None`
`relative_buffer`	`float`	Relative value of the buffer. To increase the map extent by 10 %, use the value 0.1. Defaults to None.	`None`

Source code in automaps/generators/base.py

def _zoom_map_to_layer_extent(
    self,
    map_name: str,
    layer: QgsMapLayer,
    buffer: Optional[float] = None,
    relative_buffer: Optional[float] = None,
):
    """Centers a map to the given layer and zooms to its extent. The extent can be
    increased by adding a buffer.

    Args:
        map_name (str): Name of the map to modify as defined in the associated
            print layout.
        layer (QgsMapLayer): Layer to get extent from
        buffer (float, optional): Absolute value (in map units) of the buffer.
            Defaults to None.
        relative_buffer (float, optional): Relative value of the buffer. To increase
            the map extent by 10 %, use the value 0.1. Defaults to None.
    """
    extent = layer.extent()
    if buffer is not None:
        extent = extent.buffered(buffer)
    self.step_data.layout.itemById(map_name).zoomToExtent(extent)  # type: ignore
    if relative_buffer is not None:
        scale_padded = self.step_data.layout.itemById(map_name).scale() * (
            1 + relative_buffer
        )
        self.step_data.layout.itemById(map_name).setScale(scale_padded)

`run_step(self, name)` #

Runs a single processin step.

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the step to run, as defined in `self.steps`.	required

Returns:

Type	Description
`StepData`	The data which shall be passed to the next processing step.

Source code in automaps/generators/base.py

def run_step(self, name: str) -> StepData:
    """Runs a single processin step.

    Args:
        name (str): The name of the step to run, as defined in `self.steps`.

    Returns:
        StepData: The data which shall be passed to the next processing step.
    """
    self.steps[name].func()
    self.step_data.message_to_client["rel_weight"] = (
        self.steps[name].weight / self.total_weight
    )
    return self.step_data

`Step (tuple)` #

Step(func, weight)

`getnewargs(self)` `special` #

Return self as a plain tuple. Used by copy and pickle.

Source code in automaps/generators/base.py

def __getnewargs__(self):
    'Return self as a plain tuple.  Used by copy and pickle.'
    return _tuple(self)

`new(_cls, func, weight)` `special` `staticmethod` #

Create new instance of Step(func, weight)

`repr(self)` `special` #

Return a nicely formatted representation string

Source code in automaps/generators/base.py

def __repr__(self):
    'Return a nicely formatted representation string'
    return self.__class__.__name__ + repr_fmt % self

`_asdict(self)` `private` #

Return a new dict which maps field names to their values.

Source code in automaps/generators/base.py

def _asdict(self):
    'Return a new dict which maps field names to their values.'
    return _dict(_zip(self._fields, self))

`_make(iterable)` `classmethod` `private` #

Make a new Step object from a sequence or iterable

Source code in automaps/generators/base.py

@classmethod
def _make(cls, iterable):
    result = tuple_new(cls, iterable)
    if _len(result) != num_fields:
        raise TypeError(f'Expected {num_fields} arguments, got {len(result)}')
    return result

`_replace(/, self, **kwds)` `private` #

Return a new Step object replacing specified fields with new values

Source code in automaps/generators/base.py

def _replace(self, /, **kwds):
    result = self._make(_map(kwds.pop, field_names, self))
    if kwds:
        raise ValueError(f'Got unexpected field names: {list(kwds)!r}')
    return result

generators

automaps.generators.base #

MapGenerator (ABC) #

filename: str property readonly #

__init__(self, data, basepath_fileserver, print_layout, step_data, job_uuid, default_file_format='pdf') special #

_export_print_layout(self) private #

_get_all_map_layers(self) private #

_get_map_layer(self, layer_name) private #

_get_print_layout(self) private #

_get_project(self) private #

_init_layers(self) private #

_remove_legend_node(self, layer_name) private #

_remove_map_layer_filter_expression(self, layer_name) private #

_scale_map_to_layer_extent(self, map_name, layer, scale=1000.0) private #

_set_layer_labels_visibility(self, layer_name, is_visible) private #

_set_layer_style(self, layer_name, style_name) private #

_set_map_layer_filter_expression(self, layer_name, filter_expr) private #

_set_map_layer_visibility(self, layer_names, is_visible) private #

_set_project_variable(self, var_name, var_value) private #

_set_steps(self) private #

_zoom_map_to_layer_extent(self, map_name, layer, buffer=None, relative_buffer=None) private #

run_step(self, name) #

Step (tuple) #

__getnewargs__(self) special #

__new__(_cls, func, weight) special staticmethod #

__repr__(self) special #

_asdict(self) private #

_make(iterable) classmethod private #

_replace(/, self, **kwds) private #

`automaps.generators.base` #

`MapGenerator (ABC)` #

`filename: str` `property` `readonly` #

`init(self, data, basepath_fileserver, print_layout, step_data, job_uuid, default_file_format='pdf')` `special` #

`_export_print_layout(self)` `private` #

`_get_all_map_layers(self)` `private` #

`_get_map_layer(self, layer_name)` `private` #

`_get_print_layout(self)` `private` #

`_get_project(self)` `private` #

`_init_layers(self)` `private` #

`_remove_legend_node(self, layer_name)` `private` #

`_remove_map_layer_filter_expression(self, layer_name)` `private` #

`_scale_map_to_layer_extent(self, map_name, layer, scale=1000.0)` `private` #

`_set_layer_labels_visibility(self, layer_name, is_visible)` `private` #

`_set_layer_style(self, layer_name, style_name)` `private` #

`_set_map_layer_filter_expression(self, layer_name, filter_expr)` `private` #

`_set_map_layer_visibility(self, layer_names, is_visible)` `private` #

`_set_project_variable(self, var_name, var_value)` `private` #

`_set_steps(self)` `private` #

`_zoom_map_to_layer_extent(self, map_name, layer, buffer=None, relative_buffer=None)` `private` #

`run_step(self, name)` #

`Step (tuple)` #

`getnewargs(self)` `special` #

`new(_cls, func, weight)` `special` `staticmethod` #

`repr(self)` `special` #

`_asdict(self)` `private` #

`_make(iterable)` `classmethod` `private` #

`_replace(/, self, **kwds)` `private` #