_origen.utility

Submodules

• _origen.utility.sessions
  • Classes
    • OrigenSessions
      • OrigenSessions.add_group()
      • OrigenSessions.add_standalone()
      • OrigenSessions.app_session()
      • OrigenSessions.app_session_root
      • OrigenSessions.app_sessions
      • OrigenSessions.clean()
      • OrigenSessions.delete_group()
      • OrigenSessions.delete_standalone()
      • OrigenSessions.group()
      • OrigenSessions.groups
      • OrigenSessions.refresh()
      • OrigenSessions.setup()
      • OrigenSessions.standalone()
      • OrigenSessions.standalones
      • OrigenSessions.unload()
      • OrigenSessions.user_session()
      • OrigenSessions.user_session_root
      • OrigenSessions.user_sessions
• _origen.utility.revision_control
  • Submodules
    • _origen.utility.revision_control.github
      • Functions
        • get_current_workflow_name()
        • dispatch_workflow()
  • Functions
    • app_rc()
• _origen.utility.unit_testers
  • Functions
    • app_unit_tester()
  • Classes
    • RunResult
      • RunResult.failed
      • RunResult.passed
• _origen.utility.publisher
  • Functions
    • app_publisher()
• _origen.utility.linter
• _origen.utility.release_scribe
  • Functions
    • app_release_scribe()
  • Classes
    • ReleaseScribe
      • ReleaseScribe.append_history()
      • ReleaseScribe.get_release_note()
      • ReleaseScribe.get_release_note_from_file()
      • ReleaseScribe.get_release_title()
      • ReleaseScribe.history_tracking_file
      • ReleaseScribe.read_history()
      • ReleaseScribe.release_note_file
• _origen.utility.results
  • Classes
    • BuildResult
      • BuildResult.build_contents
      • BuildResult.failed
      • BuildResult.message
      • BuildResult.metadata
      • BuildResult.succeeded
    • UploadResult
    • ExecResult
      • ExecResult.exit_code
      • ExecResult.failed()
      • ExecResult.stderr
      • ExecResult.stdout
      • ExecResult.succeeded()
• _origen.utility.website
• _origen.utility.mailer
  • Functions
    • boot_mailer()
    • boot_maillists()

Functions

• reverse_bits(): Undocumented.

• exec(): Undocumented.

• ldaps(): Undocumented.

• boot_ldaps(): Undocumented.

_origen.utility.reverse_bits(num, width=None)

_origen.utility.exec(cmd, capture=True, timeout=None, cd=None, add_env=None, remove_env=None, clear_env=False)

_origen.utility.ldaps()

_origen.utility.boot_ldaps(cat)

Classes

• Location: Helper class to store and query “location” types, which could be local paths, git URLs, as either SSH or HTTPS, or something else.

• Transaction:

class _origen.utility.Location

Helper class to store and query “location” types, which could be local paths, git URLs, as either SSH or HTTPS, or something else. The location need not be valid to create an instance of this class.

git

If the location points to a Git repo, returns that repo URL.

Notes

• Returns the Git repo for either HTTPS or SSH paths.

Returns:

Repo URL as a str, if the Location points to a Git repo None: Otherwise

Return type:

str

git_https

If the location points to a Git repo via HTTPS, returns that repo URL.

Returns:

Repo URL as a str, if the Location points to a Git repo via HTTPS None: Otherwise

Return type:

str

git_ssh

If the location points to a Git repo via SSH, returns that repo URL.

Returns:

Repo URL as a str, if the Location points to a Git repo via SSH None: Otherwise

Return type:

str

path

If the location points to an OS path, return that path.

Returns:

Repo URL as a pathlib.Path object, if the Location points to a local path. None: Otherwise

Return type:

pathlib.Path

target

Returns the location’s target, regardless of what it may be.

Returns:

Location’s target as a str

Return type:

str

url

If the location points to a web URL, returns that URL.

Returns:

URL as a str, if the Location points to a URL None: Otherwise

Return type:

str

class _origen.utility.Transaction(bc_or_val, **kwargs)

addr

addr_width

address

address_width

chunk_addr(chunk_width)

chunk_data(chunk_width)

data

classmethod new_verify(bc_or_val, **kwargs)

classmethod new_write(bc_or_val, **kwargs)

reg

register

width