options Namespace Reference

Functions
None	_option_from_pydantic_field (argparse._ArgumentGroup group, type[BaseModel] config_class, str field_name, *, str|None name=None, str|None help=None, type|None type=None, **Any kwargs)
None	common_apdb_options (argparse.ArgumentParser parser)
None	sql_config_options (argparse.ArgumentParser parser)
None	cassandra_config_options (argparse.ArgumentParser parser)

Function Documentation

_option_from_pydantic_field()

None options._option_from_pydantic_field ( argparse._ArgumentGroup group, type[BaseModel] config_class, str field_name, * , str | None name = None, str | None help = None, type | None type = None, **Any kwargs )

protected

Convert pydantic Field to argparse argument definition.

Definition at line 39 of file options.py.

) -> None:
    """Convert pydantic Field to argparse argument definition."""
    field_info = config_class.model_fields[field_name]
    if name is None:
        name = "--" + field_name.replace("_", "-")
    if help is None:
        help = field_info.description
 
    if type is None:
        type = field_info.annotation
        if type in (str, int, float):
            kwargs["type"] = type
    else:
        kwargs["type"] = type
 
    group.add_argument(name, dest=field_name, help=help, **kwargs)
 
 
# Options for fields in ApdbConfig.

cassandra_config_options()

None options.cassandra_config_options

(

argparse.ArgumentParser

parser

)

Define Cassandra backend configuration options.

Definition at line 99 of file options.py.

def cassandra_config_options(parser: argparse.ArgumentParser) -> None:
    """Define Cassandra backend configuration options."""
    group = parser.add_argument_group("Cassandra backend options")
    _option_from_pydantic_field(group, ApdbCassandraConfig, "replica_skips_diaobjects", action="store_true")
    _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "port", metavar="PORT")
    _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "username", metavar="USER")
    _option_from_pydantic_field(group, ApdbCassandraConfig, "prefix")
    group.add_argument("--replication-factor", help="Replication factor used when creating new keyspace.")
    group.add_argument(
        "--table-options", help="Path or URI of YAML file containing table options.", metavar="URI"
    )
    _option_from_pydantic_field(
        group,
        ApdbCassandraConnectionConfig,
        "read_consistency",
        choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"],
    )
    _option_from_pydantic_field(
        group,
        ApdbCassandraConnectionConfig,
        "write_consistency",
        choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"],
    )
    _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "read_timeout", metavar="SECONDS")
    _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "write_timeout", metavar="SECONDS")
    _option_from_pydantic_field(
        group,
        ApdbCassandraConfig,
        "ra_dec_columns",
        help="Names of ra/dec columns in DiaObject table, comma-separated.",
        metavar="RA_COLUMN,DEC_COLUMN",
    )
    group = parser.add_argument_group("Cassandra partitioning options")
    _option_from_pydantic_field(group, ApdbCassandraPartitioningConfig, "part_pixelization", metavar="NAME")
    _option_from_pydantic_field(group, ApdbCassandraPartitioningConfig, "part_pix_level", metavar="LEVEL")
    _option_from_pydantic_field(
        group, ApdbCassandraPartitioningConfig, "time_partition_tables", action="store_true"
    )
    _option_from_pydantic_field(
        group, ApdbCassandraPartitioningConfig, "time_partition_start", metavar="TIME"
    )
    _option_from_pydantic_field(group, ApdbCassandraPartitioningConfig, "time_partition_end", metavar="TIME")

common_apdb_options()

None options.common_apdb_options

(

argparse.ArgumentParser

parser

)

Define common configuration options.

Definition at line 67 of file options.py.

def common_apdb_options(parser: argparse.ArgumentParser) -> None:
    """Define common configuration options."""
    group = parser.add_argument_group("common APDB options")
    _option_from_pydantic_field(group, ApdbConfig, "schema_file", metavar="URL")
    _option_from_pydantic_field(group, ApdbConfig, "schema_name")
    _option_from_pydantic_field(group, ApdbConfig, "read_sources_months", metavar="NUMBER")
    _option_from_pydantic_field(group, ApdbConfig, "read_forced_sources_months", metavar="NUMBER")
    _option_from_pydantic_field(group, ApdbConfig, "enable_replica", action="store_true", default=False)
 
 
# Options for fields in ApdbSqlConfig, db_url is not included.

sql_config_options()

None options.sql_config_options

(

argparse.ArgumentParser

parser

)

Define SQL backend configuration options.

Definition at line 78 of file options.py.

def sql_config_options(parser: argparse.ArgumentParser) -> None:
    """Define SQL backend configuration options."""
    group = parser.add_argument_group("SQL backend options")
    _option_from_pydantic_field(group, ApdbSqlConfig, "namespace", metavar="IDENTIFIER")
    _option_from_pydantic_field(group, ApdbSqlConnectionConfig, "connection_timeout", metavar="SECONDS")
    _option_from_pydantic_field(
        group, ApdbSqlConfig, "dia_object_index", choices=["baseline", "pix_id_iov", "last_object_table"]
    )
    _option_from_pydantic_field(group, ApdbSqlPixelizationConfig, "htm_level")
    _option_from_pydantic_field(group, ApdbSqlPixelizationConfig, "htm_index_column")
    _option_from_pydantic_field(
        group,
        ApdbSqlConfig,
        "ra_dec_columns",
        help="Names of ra/dec columns in DiaObject table, comma-separated.",
        metavar="RA_COLUMN,DEC_COLUMN",
    )
    _option_from_pydantic_field(group, ApdbSqlConfig, "prefix")
 
 
# Options for fields in ApdbCassandraConfig, contact_points is not included.