gen_mmap.setup.factory module

Module

factory.py

Copyright

Copyright (C) 2026 Vladimir Roncevic <elektron.ronca@gmail.com> gen_mmap 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 3 of the License, or (at your option) any later version. gen_mmap is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Factory for creating the gen_mmap bundle.

class gen_mmap.setup.factory.GenMmapBundleFactory[source]

Bases: object

Factory for creating the gen_mmap bundle.

It defines:

attributes:
_info_file - Path to the gen_mmap info file.
methods:
create_bundle - Creates the gen_mmap bundle with optional pre-configured options.
get_version - Returns the factory version.
_info_file: str = '/home/docs/checkouts/readthedocs.org/user_builds/gen-mmap/checkouts/latest/gen_mmap/infrastructure/config/gen_mmap.cfg'
classmethod create_bundle(options: GenMmapBundleOptions | None = None) → GenMmapBundle[source]

Creates the gen_mmap bundle with optional pre-configured options.

Parameters:

options – The pre-configured options for the gen_mmap bundle.

Returns:

The gen_mmap bundle.

Exceptions:
ATSValueError: The gen_mmap bundle options must be provided and have proper values.
ATSTypeError: The gen_mmap bundle options must be an instance of Mapping and its
attributes must be instances of their respective types.
ATSValueError: The gen_mmap bundle dependencies must be provided and have proper values.
ATSTypeError: The gen_mmap bundle dependencies must be an instance of Mapping and its
attributes must be instances of their respective types.
ATSValueError: The gen_mmap bundle must be provided and have proper values.
ATSTypeError: The gen_mmap bundle must be an instance of GenMmapBundle and
its attributes must be instances of their respective types.
classmethod get_version() → str[source]

Returns the factory version.

Returns:

The factory version.

Exceptions:

None.