form.parser.grammar =================== .. py:module:: form.parser.grammar Attributes ---------- .. autoapisummary:: form.parser.grammar._T form.parser.grammar.printables form.parser.grammar.text form.parser.grammar.numeric Functions --------- .. autoapisummary:: form.parser.grammar.text_without form.parser.grammar.matches form.parser.grammar.literal form.parser.grammar.as_int form.parser.grammar.as_joined_string form.parser.grammar.as_decimal form.parser.grammar.as_uppercase form.parser.grammar.as_integer_range form.parser.grammar.as_decimal_range form.parser.grammar.as_regex form.parser.grammar.as_date form.parser.grammar.approximate_total_days form.parser.grammar.is_valid_date_range form.parser.grammar.as_relative_delta form.parser.grammar.unwrap form.parser.grammar.tag form.parser.grammar.with_whitespace_inside form.parser.grammar.enclosed_in form.parser.grammar.number_enclosed_in form.parser.grammar.choices_enclosed_in form.parser.grammar.mark_enclosed_in form.parser.grammar.textfield form.parser.grammar.textarea form.parser.grammar.code form.parser.grammar.password form.parser.grammar.email form.parser.grammar.url form.parser.grammar.video_url form.parser.grammar.absolute_date form.parser.grammar.relative_delta form.parser.grammar.valid_date_range form.parser.grammar.date form.parser.grammar.datetime form.parser.grammar.time form.parser.grammar.stdnum form.parser.grammar.chip_nr form.parser.grammar.fileinput form.parser.grammar.decimal form.parser.grammar.range_field form.parser.grammar.integer_range_field form.parser.grammar.decimal_range_field form.parser.grammar.currency form.parser.grammar.pricing form.parser.grammar.marker_box form.parser.grammar.radio form.parser.grammar.checkbox form.parser.grammar.fieldset_title form.parser.grammar.field_identifier form.parser.grammar.field_help_identifier Module Contents --------------- .. py:data:: _T .. py:data:: printables .. py:data:: text .. py:data:: numeric .. py:function:: text_without(characters: str) -> pyparsing.Word Returns all printable text without the given characters. .. py:function:: matches(character: str) -> collections.abc.Callable[[pyparsing.results.ParseResults], bool] Returns true if the given character matches the token. .. py:function:: literal(value: _T) -> collections.abc.Callable[[pyparsing.results.ParseResults], _T] " Returns the given value, ignoring the tokens alltogether. .. py:function:: as_int(tokens: pyparsing.results.ParseResults) -> int | None Converts the token to int if possible. .. py:function:: as_joined_string(tokens: pyparsing.results.ParseResults) -> str Joins the given tokens into a single string. .. py:function:: as_decimal(tokens: pyparsing.results.ParseResults) -> decimal.Decimal | None Converts the token to decimal if possible. .. py:function:: as_uppercase(tokens: pyparsing.results.ParseResults) -> str | None Converts the token to uppercase if possible. .. py:function:: as_integer_range(tokens: pyparsing.results.ParseResults) -> range | None Converts the token to an integer range if possible. .. py:function:: as_decimal_range(tokens: pyparsing.results.ParseResults) -> onegov.form.utils.decimal_range | None Converts the token to a decimal range if possible. .. py:function:: as_regex(tokens: pyparsing.results.ParseResults) -> re.Pattern[str] | None Converts the token to a working regex if possible. .. py:function:: as_date(instring: str, loc: int, tokens: pyparsing.results.ParseResults) -> datetime.date | None Converts the token to a date if possible. .. py:function:: approximate_total_days(delta: dateutil.relativedelta.relativedelta) -> float Computes an approximate day delta from a relativedelta. .. py:function:: is_valid_date_range(instring: str, loc: int, tokens: pyparsing.results.ParseResults) -> pyparsing.results.ParseResults Checks if the date range is valid .. py:function:: as_relative_delta(tokens: pyparsing.results.ParseResults) -> dateutil.relativedelta.relativedelta | None .. py:function:: unwrap(tokens: pyparsing.results.ParseResults) -> Any | None Unwraps grouped tokens. .. py:function:: tag(**tags: str) -> collections.abc.Callable[[pyparsing.results.ParseResults], None] Takes the given tags and applies them to the token. .. py:function:: with_whitespace_inside(expr: pyparsing.ParserElement) -> pyparsing.Combine Returns an expression that allows for whitespace inside, but not outside the expression. .. py:function:: enclosed_in(expr: pyparsing.ParserElement, characters: str) -> pyparsing.ParserElement Wraps the given expression in the given characters. .. py:function:: number_enclosed_in(characters: str) -> pyparsing.ParserElement Wraps numers in the given characters, making sure the result is an int. .. py:function:: choices_enclosed_in(characters: str, choices: collections.abc.Sequence[str]) -> pyparsing.ParserElement Wraps the given choices in the given characters, making sure only valid choices are possible. .. py:function:: mark_enclosed_in(characters: str) -> pyparsing.MatchFirst Returns a mark (x) inclosed in the given characters. For example, ``mark_enclosed_in('[]')`` creates an expression that accepts any of these and sets the result of the 'x' value to True, the others to False:: [x] [ ] .. py:function:: textfield() -> pyparsing.ParserElement Returns a textfield parser. Example:: ____[50] The number defines the maximum length. Additionally, a regex may be specified to validate the field:: ___/[0-9]{4} .. py:function:: textarea() -> pyparsing.ParserElement Returns a textarea parser. Example:: ...[5] The number defines the number of rows. .. py:function:: code() -> pyparsing.ParserElement Returns a code textfield with a specified syntax. Currently only markdown is supported. Example:: .. py:function:: password() -> pyparsing.ParserElement Returns a password field parser. Example:: *** .. py:function:: email() -> pyparsing.ParserElement Returns an email field parser. Example:: @@@ .. py:function:: url() -> pyparsing.ParserElement Returns an url field parser. Example:: http:// https:// .. py:function:: video_url() -> pyparsing.ParserElement Returns an video url field parser. Example:: video-url .. py:function:: absolute_date() -> pyparsing.ParserElement Returns an absolute date parser. Example:: 2020.10.10 .. py:function:: relative_delta() -> pyparsing.ParserElement Returns a relative delta parser. Example:: +1 days -4 weeks 0 years .. py:function:: valid_date_range() -> pyparsing.ParserElement Returns a valid date range parser. Example:: (..today) (2010.01.01..2020.01.01) (-2 weeks..+4 months) .. py:function:: date() -> pyparsing.ParserElement Returns a date parser. Example:: YYYY.MM.DD .. py:function:: datetime() -> pyparsing.ParserElement Returns a datetime parser. Example:: YYYY.MM.DD HH:MM .. py:function:: time() -> pyparsing.ParserElement Returns a time parser. Example:: HH:MM .. py:function:: stdnum() -> pyparsing.ParserElement Returns an stdnum parser. Example:: # iban .. py:function:: chip_nr() -> pyparsing.ParserElement Returns a chip number parser. Example:: chip-nr .. py:function:: fileinput() -> pyparsing.ParserElement Returns a fileinput parser. For all kindes of files:: *.* For specific files:: *.pdf|*.doc For multiple file upload:: *.pdf (multiple) .. py:function:: decimal() -> pyparsing.ParserElement Returns a decimal parser. Decimal point is '.'. For example: 0.00 123 11.1 -10.0 .. py:function:: range_field(value_expression: pyparsing.ParserElement, parse_action: collections.abc.Callable[[pyparsing.results.ParseResults], Any], type: str) -> pyparsing.ParserElement Generic range field parser. .. py:function:: integer_range_field() -> pyparsing.ParserElement Returns an integer range parser. .. py:function:: decimal_range_field() -> pyparsing.ParserElement Returns a decimal range parser. .. py:function:: currency() -> pyparsing.ParserElement Returns a currency parser. For example: chf USD Cny .. py:function:: pricing() -> pyparsing.ParserElement Returns a pricing parser. For example: (10.0 CHF) (0 usd!) (-0.50 Cny) .. py:function:: marker_box(characters: str) -> pyparsing.ParserElement Returns a marker box: Example:: (x) Male [x] Female {x} What? .. py:function:: radio() -> pyparsing.ParserElement Returns a radio parser: Example:: (x) Male ( ) Female .. py:function:: checkbox() -> pyparsing.ParserElement Returns a checkbox parser: Example:: [x] Male [ ] Female .. py:function:: fieldset_title() -> pyparsing.ParserElement A fieldset title parser. Fieldset titles are just like headings in markdown:: # My header It's possible to have an empty fieldset title (to disable a fieldset): # ... .. py:function:: field_identifier() -> pyparsing.ParserElement Returns a field identifier parser: Example:: My field * .. py:function:: field_help_identifier() -> pyparsing.ParserElement Returns parser for a field help comment following a field/fieldset: General Example: << Help text for My Field >>