Loading [MathJax]/extensions/tex2jax.js
LSST Applications g044012fb7c+2a65cdf098,g04a91732dc+10fc851f12,g07dc498a13+195d1f135d,g1409bbee79+195d1f135d,g1a7e361dbc+195d1f135d,g1fd858c14a+8f3fe8f5cb,g2179890f76+6cf9093de3,g35bb328faa+0eb18584fe,g3bd4b5ce2c+c032696bd5,g3fa7bbdb64+d4f98599f0,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+08fbe2cc28,g68385bb32d+f37fe42b18,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+270ef6db90,g89139ef638+195d1f135d,g8b49a6ea8e+08fbe2cc28,g9125e01d80+0eb18584fe,g9583089f3b+08fbe2cc28,g974caa22f6+0eb18584fe,g989de1cb63+195d1f135d,g9f33ca652e+5ce2034648,gaaedd4e678+195d1f135d,gabe3b4be73+543c3c03c9,gb1101e3267+26daace539,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+270ef6db90,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+3e62fa8f41,ge278dab8ac+ae64226a64,ge673f9641d+e40ad9942e,geab183fbe5+08fbe2cc28,gfba249425e+0eb18584fe,gfe7187db8c+c81932c5f4,w.2025.06
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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.

48) -> None:
49 """Convert pydantic Field to argparse argument definition."""
50 field_info = config_class.model_fields[field_name]
51 if name is None:
52 name = "--" + field_name.replace("_", "-")
53 if help is None:
54 help = field_info.description
55
56 if type is None:
57 type = field_info.annotation
58 if type in (str, int, float):
59 kwargs["type"] = type
60 else:
61 kwargs["type"] = type
62
63 group.add_argument(name, dest=field_name, help=help, **kwargs)
64
65
66# 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.

99def cassandra_config_options(parser: argparse.ArgumentParser) -> None:
100 """Define Cassandra backend configuration options."""
101 group = parser.add_argument_group("Cassandra backend options")
102 _option_from_pydantic_field(group, ApdbCassandraConfig, "replica_skips_diaobjects", action="store_true")
103 _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "port", metavar="PORT")
104 _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "username", metavar="USER")
105 _option_from_pydantic_field(group, ApdbCassandraConfig, "prefix")
106 group.add_argument("--replication-factor", help="Replication factor used when creating new keyspace.")
107 group.add_argument(
108 "--table-options", help="Path or URI of YAML file containing table options.", metavar="URI"
109 )
110 _option_from_pydantic_field(
111 group,
112 ApdbCassandraConnectionConfig,
113 "read_consistency",
114 choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"],
115 )
116 _option_from_pydantic_field(
117 group,
118 ApdbCassandraConnectionConfig,
119 "write_consistency",
120 choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"],
121 )
122 _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "read_timeout", metavar="SECONDS")
123 _option_from_pydantic_field(group, ApdbCassandraConnectionConfig, "write_timeout", metavar="SECONDS")
124 _option_from_pydantic_field(
125 group,
126 ApdbCassandraConfig,
127 "ra_dec_columns",
128 help="Names of ra/dec columns in DiaObject table, comma-separated.",
129 metavar="RA_COLUMN,DEC_COLUMN",
130 )
131 group = parser.add_argument_group("Cassandra partitioning options")
132 _option_from_pydantic_field(group, ApdbCassandraPartitioningConfig, "part_pixelization", metavar="NAME")
133 _option_from_pydantic_field(group, ApdbCassandraPartitioningConfig, "part_pix_level", metavar="LEVEL")
134 _option_from_pydantic_field(
135 group, ApdbCassandraPartitioningConfig, "time_partition_tables", action="store_true"
136 )
137 _option_from_pydantic_field(
138 group, ApdbCassandraPartitioningConfig, "time_partition_start", metavar="TIME"
139 )
140 _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.

67def common_apdb_options(parser: argparse.ArgumentParser) -> None:
68 """Define common configuration options."""
69 group = parser.add_argument_group("common APDB options")
70 _option_from_pydantic_field(group, ApdbConfig, "schema_file", metavar="URL")
71 _option_from_pydantic_field(group, ApdbConfig, "schema_name")
72 _option_from_pydantic_field(group, ApdbConfig, "read_sources_months", metavar="NUMBER")
73 _option_from_pydantic_field(group, ApdbConfig, "read_forced_sources_months", metavar="NUMBER")
74 _option_from_pydantic_field(group, ApdbConfig, "enable_replica", action="store_true", default=False)
75
76
77# 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.

78def sql_config_options(parser: argparse.ArgumentParser) -> None:
79 """Define SQL backend configuration options."""
80 group = parser.add_argument_group("SQL backend options")
81 _option_from_pydantic_field(group, ApdbSqlConfig, "namespace", metavar="IDENTIFIER")
82 _option_from_pydantic_field(group, ApdbSqlConnectionConfig, "connection_timeout", metavar="SECONDS")
83 _option_from_pydantic_field(
84 group, ApdbSqlConfig, "dia_object_index", choices=["baseline", "pix_id_iov", "last_object_table"]
85 )
86 _option_from_pydantic_field(group, ApdbSqlPixelizationConfig, "htm_level")
87 _option_from_pydantic_field(group, ApdbSqlPixelizationConfig, "htm_index_column")
88 _option_from_pydantic_field(
89 group,
90 ApdbSqlConfig,
91 "ra_dec_columns",
92 help="Names of ra/dec columns in DiaObject table, comma-separated.",
93 metavar="RA_COLUMN,DEC_COLUMN",
94 )
95 _option_from_pydantic_field(group, ApdbSqlConfig, "prefix")
96
97
98# Options for fields in ApdbCassandraConfig, contact_points is not included.