winspsrc.scripts package

Submodules

winspsrc.scripts.extract module

Script to extract Windows serialized property information.

winspsrc.scripts.extract.Main()

Entry point of console script to extract property information.

Returns:

exit code that is provided to sys.exit().

Return type:

int

winspsrc.scripts.generate_docs module

Script to generate Windows serialized property documentation.

class winspsrc.scripts.generate_docs.IndexRstOutputWriter(path)

Bases: object

Index.rst output writer.

WritePropertySet(format_identifier)

Writes a property set to the index.rst file.

Parameters:

format_identifier (str) – format identifier.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes an index.rst output writer.

winspsrc.scripts.generate_docs.Main()

Entry point of console script to generate property documentation.

Returns:

exit code that is provided to sys.exit().

Return type:

int

class winspsrc.scripts.generate_docs.MarkdownOutputWriter(path)

Bases: object

Markdown output writer.

WritePropertySet(property_set)

Writes a property set to a Markdown file.

Parameters:

property_set (list[SerializedPropertyDefinition]) – property set.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a Markdown output writer.

winspsrc.scripts.generate_source module

Script to generate Windows serialized property source code.

winspsrc.scripts.generate_source.Main()

Entry point of console script to generate property source code.

Returns:

exit code that is provided to sys.exit().

Return type:

int

winspsrc.scripts.merge_yaml module

Script to combine winsps-kb YAML files.

winspsrc.scripts.merge_yaml.Main()

Entry point of console script to combine winsps-kb YAML files.

Returns:

exit code that is provided to sys.exit().

Return type:

int

class winspsrc.scripts.merge_yaml.YAMLOutputWriter

Bases: object

YAML output writer.

WritePropertyDefinition(property_definition)

Writes a property definition in YAML to stdout.

Parameters:

property_definition (SerializedPropertyDefinition) – property definition.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

winspsrc.scripts.resolve_names module

Module contents