common package

Subpackages

• common.application_layer package
  • Subpackages
    • common.application_layer.orm_repositories package
      • Submodules
      • common.application_layer.orm_repositories.initialize_persistence module
      • common.application_layer.orm_repositories.orm_model module
      • common.application_layer.orm_repositories.orm_repository module
      • common.application_layer.orm_repositories.orm_types module
      • Module contents
    • common.application_layer.rest_api package
      • Subpackages
      • Submodules
      • common.application_layer.rest_api.routes module
      • common.application_layer.rest_api.server module
      • common.application_layer.rest_api.tweens module
      • Module contents
    • common.application_layer.services package
      • Submodules
      • common.application_layer.services.gbo_calculator_service module
      • common.application_layer.services.notification_sender_service module
      • common.application_layer.services.permissions_service module
      • common.application_layer.services.rct_service module
      • common.application_layer.services.vla_calculator_service module
      • Module contents
  • Module contents
• common.domain_layer package
  • Subpackages
    • common.domain_layer.entities package
      • Submodules
      • common.domain_layer.entities.base module
      • common.domain_layer.entities.user module
      • Module contents
    • common.domain_layer.repositories package
      • Submodules
      • common.domain_layer.repositories.repository module
      • common.domain_layer.repositories.sub_repository module
      • Module contents
  • Module contents
    • JSON
    • JSON_ARRAY
    • JSON_OBJECT
    • ValidUnits
      • ValidUnits.Angle
      • ValidUnits.DataRate
      • ValidUnits.DumpTime
      • ValidUnits.Frequency
      • ValidUnits.Time
    • validate_units()
• common.test_helpers package
  • Submodules
  • common.test_helpers.testhelpers module
  • Module contents

Module contents

Contain utility functions used across middle_layer packages

exception common.CalculationError

Bases: Exception

common.config() → Path

Return the path to configuration files (typically middle_layer/config).

common.get_application_base_url()

common.get_middle_layer() → Path

Find the middle_layer directory in an efficient-ish manner

common.get_parents_matching(directory: Path, query: str) → list[Path]

common.parse_iso_8601_strings(string: str) → DateTime

Parse an ISO 8601 datetime string into a pendulum.DateTime

Parameters:

string – String to parse

Returns:

Parsed DateTime

Raises:

• ValueError – If string is parsed successfully but isn’t a DateTime

• ParserError – If Pendulum fails to parse string

common.solicitation_templates() → Path

Return the path to solicitation templates (typically middle_layer/solicitation_templates).

common.stringify_declination(declination: Quantity) → str

common.stringify_right_ascension(right_ascension: Quantity) → str

common.strtobool(a_string: str) → bool

common.sum_quantities(quants: list[Quantity]) → Quantity

Preserve units even if sum() returns 0

common.testing_data() → Path

Return the path to test data files (typically middle_layer/test/testing_data).