refspy.models.format

Data object for reference formatting options.

The Format objects are used by the refspy.formatter.Formatter to turn references into different kinds of strings. Properties are named by their characters in normal English formatting. Attributes should contain any necessary spacing to be added before or after characters.

Attributes:
  • colon: ':' in English
  • comma: ',' in English
  • dash: '-' in English
  • semicolon: ';' in English
  • book_only: e.g. 'Romans'
  • number_only: e.g. '12:16'
  • property: 'name' (or None)
Note:

If book_only is true, number_only is ignored.

 1"""
 2Data object for reference formatting options.
 3
 4The Format objects are used by the `refspy.formatter.Formatter` to turn
 5references into different kinds of strings. Properties are named by their
 6characters in normal English formatting. Attributes should contain any
 7necessary spacing to be added before or after characters.
 8
 9Attributes:
10    colon: ':' in English
11    comma: ',' in English
12    dash: '-' in English
13    semicolon: ';' in English
14    book_only: e.g. 'Romans'
15    number_only: e.g. '12:16'
16    property: 'name' (or None)
17
18Note:
19    If book_only is true, number_only is ignored.
20"""
21
22from pydantic import BaseModel
23
24
25class Format(BaseModel):
26    colon: str
27    comma: str
28    dash: str
29    semicolon: str
30    book_only: bool
31    number_only: bool
32    property: str | None
class Format(pydantic.main.BaseModel): 
26class Format(BaseModel):
27    colon: str
28    comma: str
29    dash: str
30    semicolon: str
31    book_only: bool
32    number_only: bool
33    property: str | None

!!! abstract "Usage Documentation" Models

A base class for creating Pydantic models.

Attributes:
  • __class_vars__: The names of the class variables defined on the model.
  • __private_attributes__: Metadata about the private attributes of the model.
  • __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.
  • __pydantic_complete__: Whether model building is completed, or if there are still undefined fields.
  • __pydantic_core_schema__: The core schema of the model.
  • __pydantic_custom_init__: Whether the model has a custom __init__ function.
  • __pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
  • __pydantic_generic_metadata__: A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.
  • __pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.
  • __pydantic_post_init__: The name of the post-init method for the model, if defined.
  • __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel].
  • __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model.
  • __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.
  • __pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
  • __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
  • __pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.
  • __pydantic_fields_set__: The names of fields explicitly set during instantiation.
  • __pydantic_private__: Values of private attributes set on the model instance.
colon: str
comma: str
dash: str
semicolon: str
book_only: bool
number_only: bool
property: str | None
model_config: ClassVar[pydantic.config.ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].