hydra.overlay.python.dsl.annotations module

A DSL which is used as a basis for some of the other DSLs.

hydra.overlay.python.dsl.annotations.annotate_term(key: Name, mvalue: object, term: Term) → Term

Add an annotation to a term.

hydra.overlay.python.dsl.annotations.annotate_type(key: Name, mvalue: object, typ: Type) → Type

Add an annotation to a type.

hydra.overlay.python.dsl.annotations.bounded(min_len: object, max_len: object, typ: Type) → Type

Apply minimum and maximum length bounds to a type.

hydra.overlay.python.dsl.annotations.bounded_list(min_len: object, max_len: object, et: Type) → Type

Create a bounded list type.

hydra.overlay.python.dsl.annotations.bounded_map(min_len: object, max_len: object, kt: Type, vt: Type) → Type

Create a bounded map type.

hydra.overlay.python.dsl.annotations.bounded_set(min_len: object, max_len: object, et: Type) → Type

Create a bounded set type.

hydra.overlay.python.dsl.annotations.bounded_string(min_len: object, max_len: object) → Type

Create a bounded string type.

hydra.overlay.python.dsl.annotations.data_doc(s: str, term: Term) → Term

Add documentation to a term.

hydra.overlay.python.dsl.annotations.deprecated(typ: Type) → Type

Mark a type as deprecated.

hydra.overlay.python.dsl.annotations.doc(s: str, typ: Type) → Type

Add documentation to a type.

hydra.overlay.python.dsl.annotations.doc70(s: str, typ: Type) → Type

Add documentation with line wrapping at 70 characters.

hydra.overlay.python.dsl.annotations.doc80(s: str, typ: Type) → Type

Add documentation with line wrapping at 80 characters.

hydra.overlay.python.dsl.annotations.exclude(typ: Type) → Type

Mark a type to be excluded.

hydra.overlay.python.dsl.annotations.min_length_list(length: int, et: Type) → Type

Create a list type with minimum length.

hydra.overlay.python.dsl.annotations.nonempty_list(et: Type) → Type

Create a non-empty list type.

hydra.overlay.python.dsl.annotations.nonempty_map(kt: Type, vt: Type) → Type

Create a non-empty map type.

hydra.overlay.python.dsl.annotations.note(s: str, typ: Type) → Type

Add a note to a type.

hydra.overlay.python.dsl.annotations.preserve_field_name(typ: Type) → Type

Mark a field name to be preserved.

hydra.overlay.python.dsl.annotations.see(s: str, typ: Type) → Type

Add a ‘see’ reference to a type.

hydra.overlay.python.dsl.annotations.set_max_length(m: int, typ: Type) → Type

Set the maximum length annotation.

hydra.overlay.python.dsl.annotations.set_min_length(m: int, typ: Type) → Type

Set the minimum length annotation.

hydra.overlay.python.dsl.annotations.set_term_annotation(key: Name, mvalue: object, term: Term) → Term

Set an annotation on a term.

hydra.overlay.python.dsl.annotations.set_term_description(desc: object, term: Term) → Term

Set the description annotation on a term.

hydra.overlay.python.dsl.annotations.set_type_annotation(key: Name, mvalue: object, typ: Type) → Type

Set an annotation on a type.

hydra.overlay.python.dsl.annotations.set_type_description(desc: object, typ: Type) → Type

Set the description annotation on a type.

hydra.overlay.python.dsl.annotations.two_or_more_list(et: Type) → Type

Create a list type with at least two elements.

hydra.overlay.python.dsl.annotations.wrap_line(width: int, text: str) → str

Wrap a line of text at the specified width.