pymakehelper package

Submodules

pymakehelper.configs module

All configurations for pymakehelper

class pymakehelper.configs.ConfigPdflatex

Bases: Config

Parameters for pdflatex

input_file = <pytconf.param.Unique object>

output_file = <pytconf.param.Unique object>

qpdf = True

remove_tmp = True

runs = 2

class pymakehelper.configs.ConfigSymlinkInstall

Bases: Config

Parameters for the symlink install tool

debug = True

doit = True

incremental = True

recurse = True

source_folder = <pytconf.param.Unique object>

target_folder = <pytconf.param.Unique object>

unlink = False

unlink_all = False

class pymakehelper.configs.ConfigVerbose

Bases: Config

Parameters for verbosity

verbose = False

pymakehelper.main module

main file

pymakehelper.main.env() → None

pymakehelper.main.error_on_print() → None

pymakehelper.main.error_on_print_or_error() → None

pymakehelper.main.main()

pymakehelper.main.no_err() → None

pymakehelper.main.only_print_on_error() → None

pymakehelper.main.remove_folders() → None

pymakehelper.main.reverse_exitcode() → None

pymakehelper.main.run_make() → None

pymakehelper.main.run_with_ignore() → None

pymakehelper.main.symlink_install() → None

pymakehelper.main.touch_mkdir() → None

pymakehelper.main.wrapper_css_validator() → None

pymakehelper.main.wrapper_pdflatex() → None

pymakehelper.static module

version which can be consumed from within the module

pymakehelper.subprocess module

This module provides a simple wrapper around the subprocess module

pymakehelper.subprocess.run_error_on_print(args: list[str])

pymakehelper.subprocess.run_error_on_print_or_error(args: list[str])

pymakehelper.subprocess.run_no_err(args: list[str])

pymakehelper.subprocess.run_only_print_on_error(args: list[str])

pymakehelper.utils module

utils.py

pymakehelper.utils.do_install(source, target)

install a single symlink

pymakehelper.utils.do_real_install(source, target)

This does the real installation

pymakehelper.utils.ensure_dir(f, exist_ok=True)

pymakehelper.utils.file_gen(root_folder: str, recurse: bool)

generate all files in a folder

pymakehelper.utils.get_flags(filename: str) → set[str]

read the content of a file and get all the flags declared in it

pymakehelper.utils.get_logger()

pymakehelper.utils.touch(f)

pymakehelper.utils.touch_mkdir(f)

pymakehelper.utils.touch_mkdir_many(filenames)

pymakehelper.utils.unlink_check(filename: str)

this is a function that removes a file and can optionally die if there is a problem

pymakehelper.wrapper_pdflatex module

This is a script that runs pdflatex for us. Why do we need this script ? - to remove the output before we run pdflatex so that we will be sure that we start clean. if pdflatex finds a file it will * reprocess * it and we dont want that, do we ? - we need to run pdflatex twice to create indexes and more. - pdf latex is way too verbose - we want to remove that output and only show it if there is an error. - in case we fail we want to make sure we remove the output.

Maybe more reasons will follow…

Take note of the argument we pass to pdflatex: - -interaction=nonstopmode - this means that latex will not stop and enter interactive mode to ask the user what to do about an error (what is this behaviour anyway ?!?). - -halt-on-error - this means that latex will stop on error. - -output-directory - this tells pdflatex where the output folder is.

This python script is a rewrite of a similar script in perl.

pymakehelper.wrapper_pdflatex.chmod_check(filename: str, check: bool)

this is a function that chmods a file and can optionally die if there is a problem

pymakehelper.wrapper_pdflatex.my_rename(old_filename: str, new_filename: str, check: bool)

this is a function that renames a file and dies if there is a problem

pymakehelper.wrapper_pdflatex.printout(filename: str)

print to stdout a file content this function is adjusted for the ugly output that pdflatex produces and so it only prints the lines between lines starting with “!” (including the actual lines starting with “!”). Apparently this is how pdflatex shows errors. Ugrrr…

pymakehelper.wrapper_pdflatex.run_wrapper_pdflatex()

main entry point

Module contents

Initialize the module