options Namespace Reference

Functions
None	_option_from_pex_field (argparse._ArgumentGroup group, Field field, *str|None name=None, str|None help=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_pex_field()

None options._option_from_pex_field ( argparse._ArgumentGroup group, Field field, *str | None name = None, str | None help = None, **Any kwargs )

protected

Convert pex_config Field to argparse argument definition.

Definition at line 37 of file options.py.

) -> None:
    """Convert pex_config Field to argparse argument definition."""
    if name is None:
        name = "--" + field.name.replace("_", "-")
    if help is None:
        help = field.doc
    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 87 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_pex_field(
        group,
        ApdbCassandraConfig.use_insert_id_skips_diaobjects,
        name="--replica-skips-diaobjects",
        action="store_true",
    )
    _option_from_pex_field(group, ApdbCassandraConfig.port, type=int, metavar="PORT")
    _option_from_pex_field(group, ApdbCassandraConfig.username, metavar="USER")
    _option_from_pex_field(group, ApdbCassandraConfig.prefix)
    group.add_argument(
        "--replication-factor", help="Replication factor used when creating new keyspace.", type=int
    )
    _option_from_pex_field(
        group, ApdbCassandraConfig.read_consistency, choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"]
    )
    _option_from_pex_field(
        group, ApdbCassandraConfig.write_consistency, choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"]
    )
    _option_from_pex_field(group, ApdbCassandraConfig.read_timeout, type=int, metavar="SECONDS")
    _option_from_pex_field(group, ApdbCassandraConfig.write_timeout, type=int, metavar="SECONDS")
    _option_from_pex_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_pex_field(group, ApdbCassandraConfig.part_pixelization, metavar="NAME")
    _option_from_pex_field(group, ApdbCassandraConfig.part_pix_level, type=int, metavar="LEVEL")
    _option_from_pex_field(group, ApdbCassandraConfig.time_partition_tables, action="store_true")
    _option_from_pex_field(group, ApdbCassandraConfig.time_partition_start, metavar="TIME")
    _option_from_pex_field(group, ApdbCassandraConfig.time_partition_end, metavar="TIME")

common_apdb_options()

None options.common_apdb_options

(

argparse.ArgumentParser

parser

)

Define common configuration options.

Definition at line 54 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_pex_field(group, ApdbConfig.schema_file, metavar="URL")
    _option_from_pex_field(group, ApdbConfig.schema_name)
    _option_from_pex_field(group, ApdbConfig.read_sources_months, type=int)
    _option_from_pex_field(group, ApdbConfig.read_forced_sources_months, type=int)
    _option_from_pex_field(
        group, ApdbConfig.use_insert_id, name="--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 67 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_pex_field(group, ApdbSqlConfig.namespace, metavar="IDENTIFIER")
    _option_from_pex_field(group, ApdbSqlConfig.connection_timeout, type=int, metavar="SECONDS")
    _option_from_pex_field(
        group, ApdbSqlConfig.dia_object_index, choices=["baseline", "pix_id_iov", "last_object_table"]
    )
    _option_from_pex_field(group, ApdbSqlConfig.htm_level, type=int)
    _option_from_pex_field(group, ApdbSqlConfig.htm_index_column)
    _option_from_pex_field(
        group,
        ApdbSqlConfig.ra_dec_columns,
        help="Names of ra/dec columns in DiaObject table, comma-separated.",
        metavar="RA_COLUMN,DEC_COLUMN",
    )
    _option_from_pex_field(group, ApdbSqlConfig.prefix)
 
 
# Options for fields in ApdbCassandraConfig, contact_points is not included.