winshlrc.scripts package

Submodules

winshlrc.scripts.extract module

Script to extract Windows shell information.

winshlrc.scripts.extract.Main()

Entry point of console script to extract Windows shell information.

Returns:

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

Return type:

int

winshlrc.scripts.generate_docs module

Script to generate Windows shell documentation.

class winshlrc.scripts.generate_docs.ControlPanelItemMarkdownOutputWriter(path)

Bases: object

Control panel item Markdown output writer.

WriteControlPanelItem(control_panel_item_definition)

Writes a control panel item to a Markdown file.

Parameters:

control_panel_item_definition (ControlPanelItemDefinition) – control panel item definition.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a control panel item Markdown output writer.

class winshlrc.scripts.generate_docs.ControlPanelItemsIndexRstOutputWriter(path)

Bases: object

Control panel items folder Index.rst output writer.

WriteControlPanelItem(control_panel_item_identifier)

Writes a control panel item to the index.rst file.

Parameters:

control_panel_item_identifier (str) – control panel item identifier.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a control panel items index.rst output writer.

class winshlrc.scripts.generate_docs.KnownFolderMarkdownOutputWriter(path)

Bases: object

Known folder Markdown output writer.

WriteKnownFolder(known_folder_definition)

Writes a known folder to a Markdown file.

Parameters:

known_folder_definition (KnownFolderDefinition) – known folder definition.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a known folder Markdown output writer.

class winshlrc.scripts.generate_docs.KnownFoldersIndexRstOutputWriter(path)

Bases: object

Known folders Index.rst output writer.

WriteKnownFolder(known_folder_identifier)

Writes a known folder to the index.rst file.

Parameters:

known_folder_identifier (str) – known folder identifier.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a known folders index.rst output writer.

winshlrc.scripts.generate_docs.Main()

Entry point of console script to generate Windows shell documentation.

Returns:

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

Return type:

int

class winshlrc.scripts.generate_docs.ShellFolderMarkdownOutputWriter(path)

Bases: object

Shell folder Markdown output writer.

WriteShellFolder(shell_folder_definition)

Writes a shell folder to a Markdown file.

Parameters:

shell_folder_definition (ShellFolderDefinition) – shell folder definition.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a shell folder Markdown output writer.

class winshlrc.scripts.generate_docs.ShellFoldersIndexRstOutputWriter(path)

Bases: object

Shell folders Index.rst output writer.

WriteShellFolder(shell_folder_identifier)

Writes a shell folder to the index.rst file.

Parameters:

shell_folder_identifier (str) – shell folder identifier.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

__init__(path)

Initializes a shell folders index.rst output writer.

winshlrc.scripts.generate_source module

Script to generate Windows shell related source code.

class winshlrc.scripts.generate_source.LibfwsiControlPanelItemIdentifierGenerator(path)

Bases: object

Generator for libfwsi control_panel_item_identifier.[ch] source code.

GenerateCFile(control_panel_items)

Generates the C source code file.

Parameters:

control_panel_items (dict[str, ControlPanelItemDefinition]) – control panel item per name.

GenerateHFile(control_panel_items)

Generates the H source code file.

Parameters:

control_panel_items (dict[str, ControlPanelItemDefinition]) – control panel item per name.

__init__(path)

Initializes a libfwsi control_panel_item_identifier.[ch] generator.

Parameters:

path (str) – path.

class winshlrc.scripts.generate_source.LibfwsiKnownFolderIdentifierGenerator(path)

Bases: object

Generator for libfwsi known_folder_identifier.[ch] source code.

GenerateCFile(known_folders)

Generates the C source code file.

Parameters:

known_folders (dict[str, KnownFolderDefinition]) – known folders per name.

GenerateHFile(known_folders)

Generates the H source code file.

Parameters:

known_folders (dict[str, KnownFolderDefinition]) – known folders per name.

__init__(path)

Initializes a libfwsi known_folder_identifier.[ch] generator.

Parameters:

path (str) – path.

class winshlrc.scripts.generate_source.LibfwsiShellFolderIdentifierGenerator(path)

Bases: object

Generator for libfwsi shell_folder_identifier.[ch] source code.

GenerateCFile(shell_folders)

Generates the C source code file.

Parameters:

shell_folders (dict[str, ShellFolderDefinition]) – shell folders per name.

GenerateHFile(shell_folders)

Generates the H source code file.

Parameters:

shell_folders (dict[str, ShellFolderDefinition]) – shell folders per name.

__init__(path)

Initializes a libfwsi shell_folder_identifier.[ch] generator.

Parameters:

path (str) – path.

winshlrc.scripts.generate_source.Main()

Entry point of console script to generate source code.

Returns:

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

Return type:

int

winshlrc.scripts.merge_yaml module

Script to combine winshl-kb YAML files.

winshlrc.scripts.merge_yaml.Main()

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

Returns:

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

Return type:

int

class winshlrc.scripts.merge_yaml.YAMLOutputWriter

Bases: object

YAML output writer.

WriteKnownFolder(known_folder_definition)

Writes a known folder definition in YAML to stdout.

Parameters:

known_folder_definition (KnownFolderDefinition) – known folder definition.

__enter__()

Make this work with the ‘with’ statement.

__exit__(exception_type, value, traceback)

Make this work with the ‘with’ statement.

Module contents