project_config.serializers package

Object serializers.

class project_config.serializers.SerializerDefinitionType(*args, **kwargs)

Bases: dict

Serializer definition type.

function: typing_extensions.NotRequired[str]

function_kwargs_from_url_path: typing_extensions.NotRequired[Callable[[str], Dict[str, Any]]]

module: str

exception project_config.serializers.SerializerError(message: str)

Bases: project_config.exceptions.ProjectConfigException

Error happened serializing content as JSON.

message: str

class project_config.serializers.SerializerFunction(*args, **kwargs)

Bases: Protocol

Typecheck protocol for function resolved by serialization factory.

_abc_impl = <_abc_data object>

_is_protocol = True

project_config.serializers._file_can_not_be_serialized_as_object_error(url: str, error_message: str) → str

project_config.serializers._get_serializer(url: str, prefer_serializer: Optional[str] = None) → project_config.serializers.SerializerFunction

project_config.serializers._identify_serializer(filename: str) → List[project_config.serializers.SerializerDefinitionType]

project_config.serializers.guess_preferred_serializer(url: str) → Tuple[str, Optional[str]]

Guess preferred serializer for URL.

Parameters

url (str) – URL to guess serializer for.

Returns

Preferred serializer.

Return type

str

project_config.serializers.serialize_for_url(url: str, string: str, prefer_serializer: Optional[str] = None) → Dict[str, Any]

Serializes to JSON a string according to the given URI.

Parameters

• url (str) – URI of the file, used to detect the type of the file, either using the extension or through identify.

• string (str) – File content to serialize.

Returns

Result of the object serialization.

Return type

dict

Submodules

• project_config.serializers.editorconfig module
• project_config.serializers.ini module
• project_config.serializers.python module
• project_config.serializers.text module
• project_config.serializers.yaml module