pakages package

Subpackages

• pakages.builders package
  • Subpackages
    • pakages.builders.spack package
      • Submodules
      • pakages.builders.spack.cache module
      • pakages.builders.spack.client module
      • pakages.builders.spack.sbom module
      • pakages.builders.spack.utils module
      • Module contents
  • Submodules
  • pakages.builders.python module
    • PythonPackage
      • PythonPackage.build()
      • PythonPackage.matches()
  • Module contents
    • get_package()
• pakages.cli package
  • Submodules
  • pakages.cli.build module
    • main()
  • pakages.cli.config module
    • main()
  • pakages.cli.helpers module
    • parse_extra()
  • pakages.cli.install module
    • main()
  • pakages.cli.shell module
    • create_client()
    • ipython()
    • main()
    • python()
  • Module contents
    • get_parser()
    • run_main()
• pakages.handlers package
  • Submodules
  • pakages.handlers.github module
    • GitHub
      • GitHub.clone()
      • GitHub.get()
      • GitHub.get_org_packages()
      • GitHub.init_headers()
  • Module contents
• pakages.utils package
  • Submodules
  • pakages.utils.command module
    • Capturing
      • Capturing.cleanup()
      • Capturing.err
      • Capturing.out
      • Capturing.set_stderr()
      • Capturing.set_stdout()
    • Command
      • Command.decode()
      • Command.export()
      • Command.get_command()
      • Command.run()
      • Command.summary()
  • pakages.utils.fileio module
    • copyfile()
    • get_file_hash()
    • get_tmpdir()
    • get_tmpfile()
    • mkdir_p()
    • mkdirp()
    • print_json()
    • read_file()
    • read_json()
    • read_yaml()
    • recursive_find()
    • workdir()
    • write_file()
    • write_json()
  • pakages.utils.terminal module
    • check_install()
    • confirm_action()
    • get_installdir()
    • get_user()
    • get_userhome()
    • run_command()
    • stream_command()
    • which()
  • Module contents

Submodules

pakages.build module

class pakages.build.BuildResult(builder, tmpdir, annotations=None)

Bases: object

A BuildResult holds a set of content types and objects to upload.

We also store the builder name (e.g., Python) so we know how to extract.

add_archive(path, mediaType)

Add an archive to the build result

add_title(path, title)

Add a specific title for a blob.

push(target)

Push archives to a target

remove()

Delete temporary directory

summary()

Print a summary of files

pakages.client module

class pakages.client.PakagesClient(*args, **kwargs)

Bases: object

Pakages has a main controller for interacting with pakages.

build(*args, **kwargs)

Build one or more packages.

install(packages, registry=None, tag=None, **kwargs)

Install one or more packages.

push(uri, cache_dir=None, tag=None)

Given an existing cache directory, push known specs to a specific uri

uninstall(packages)

Uninstall a pakage

pakages.client.get_client(builder=None, settings_file=None)

Get a pakages client

pakages.defaults module

pakages.logger module

class pakages.logger.ColorizingStreamHandler(nocolor=False, stream=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, use_threads=False)

Bases: StreamHandler

BLACK = 0

BLUE = 4

BOLD_SEQ = '\x1b[1m'

COLOR_SEQ = '\x1b[%dm'

CYAN = 6

GREEN = 2

MAGENTA = 5

RED = 1

RESET_SEQ = '\x1b[0m'

WHITE = 7

YELLOW = 3

can_color_tty()

colors = {'CRITICAL': 1, 'DEBUG': 4, 'ERROR': 1, 'INFO': 2, 'WARNING': 3}

decorate(record)

emit(record)

Emit a record.

If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline. If exception information is present, it is formatted using traceback.print_exception and appended to the stream. If the stream has an ‘encoding’ attribute, it is used to determine how to do the output to the stream.

property is_tty

class pakages.logger.Logger

Bases: object

cleanup()

debug(msg)

error(msg)

exit(msg, return_code=1)

handler(msg)

info(msg)

location(msg)

progress(done=None, total=None)

set_level(level)

set_stream_handler(stream_handler)

shellcmd(msg)

text_handler(msg)

The default snakemake log handler. Prints the output to the console. Args:

msg (dict): the log message dictionary

warning(msg)

pakages.logger.setup_logger(quiet=False, printshellcmds=False, nocolor=False, stdout=False, debug=False, use_threads=False, wms_monitor=None)

pakages.oras module

class pakages.oras.Registry(hostname: str | None = None, insecure: bool = False)

Bases: Registry

push(**kwargs)

pakages.oras.get_oras_client()

Consistent method to get an oras client

pakages.oras.pull_to_dir(pull_dir, target)

Given a URI, pull to an output directory.

pakages.schemas module

pakages.settings module

class pakages.settings.EmptySettings

Bases: object

add(key, value)

Add a value to a list parameter

change_validate(key, value)

A courtesy function to validate a new config addition.

delete(key)

edit()

Interactively edit a config file.

get(key, default=None)

Get a settings value, doing appropriate substitution and expansion.

get_settings_file(settings_file=None)

Get the preferred used settings file.

inituser()

Create a user specific config in user’s home.

load(settings_file=None)

Load the settings file into the settings object

remove(key, value)

Remove a value from a list parameter

save(filename=None)

Save settings, but do not change order of anything.

set(key, value)

Set a setting based on key and value. If the key has :, it’s nested

validate()

Validate the loaded settings with jsonschema

class pakages.settings.Settings(settings_file, validate=True)

Bases: EmptySettings

The settings class is a wrapper for easily parsing a settings.yml file.

We parse into a query-able class. It also gives us control to update settings, meaning we change the values and then write them to file. It’s basically a dictionary-like class with extra functions.

pakages.version module

pakages.worker module

class pakages.worker.Workers(workers=None)

Bases: object

end()

run(funcs: dict, tasks: dict) → dict | None

Run will send a list of tasks, a tuple with arguments, through a function. the arguments should be ordered correctly.

Args:

• funcs (dict)the functions to run with multiprocessing.pool,

  a dictionary with lookup by the task name

• tasks (dict)a dict of tasks, each task name (key) with a tuple

  of arguments to process

start()

pakages.worker.init_worker()

pakages.worker.multi_package(func, kwargs)

pakages.worker.multi_wrapper(func_args)

Module contents