form.parser.grammar

Attributes

printables
text
numeric
word_re
no_printable_or_whitespace_re

Classes

RelativeDate

The relativedelta type is designed to be applied to an existing datetime and

Functions

text_without_re(→ str)	Returns a re group for text without the given characters.
text_without(→ pyparsing.Word)	Returns all printable text without the given characters.
matches(...)	Returns true if the given character matches the token.
literal(...)	" Returns the given value, ignoring the tokens alltogether.
as_int(→ int | None)	Converts the token to int if possible.
as_joined_string(→ str)	Joins the given tokens into a single string.
as_decimal(→ decimal.Decimal | None)	Converts the token to decimal if possible.
as_uppercase(→ str | None)	Converts the token to uppercase if possible.
as_integer_range(→ range | None)	Converts the token to an integer range if possible.
as_decimal_range(→ onegov.form.utils.decimal_range | None)	Converts the token to a decimal range if possible.
as_regex(→ re.Pattern[str] | None)	Converts the token to a working regex if possible.
as_date(→ datetime.date | None)	Converts the token to a date if possible.
is_valid_date_range(→ pyparsing.results.ParseResults)	Checks if the date range is valid
is_valid_currency(→ str | None)
as_relative_date(→ RelativeDate | None)
unwrap(→ Any | None)	Unwraps grouped tokens.
tag(...)	Takes the given tags and applies them to the token.
with_whitespace_inside(→ pyparsing.Combine)	Returns an expression that allows for whitespace inside, but not
enclosed_in(→ pyparsing.ParserElement)	Wraps the given expression in the given characters.
number_enclosed_in(→ pyparsing.ParserElement)	Wraps numers in the given characters, making sure the result is an int.
choices_enclosed_in(→ pyparsing.ParserElement)	Wraps the given choices in the given characters, making sure only
mark_enclosed_in(→ pyparsing.MatchFirst)	Returns a mark (x) inclosed in the given characters. For example,
textfield(→ pyparsing.ParserElement)	Returns a textfield parser.
textarea(→ pyparsing.ParserElement)	Returns a textarea parser.
code(→ pyparsing.ParserElement)	Returns a code textfield with a specified syntax.
password(→ pyparsing.ParserElement)	Returns a password field parser.
email(→ pyparsing.ParserElement)	Returns an email field parser.
url(→ pyparsing.ParserElement)	Returns an url field parser.
video_url(→ pyparsing.ParserElement)	Returns an video url field parser.
absolute_date(→ pyparsing.ParserElement)	Returns an absolute date parser.
relative_date(→ pyparsing.ParserElement)	Returns a relative date parser.
valid_date_range(→ pyparsing.ParserElement)	Returns a valid date range parser.
date(→ pyparsing.ParserElement)	Returns a date parser.
datetime(→ pyparsing.ParserElement)	Returns a datetime parser.
time(→ pyparsing.ParserElement)	Returns a time parser.
stdnum(→ pyparsing.ParserElement)	Returns an stdnum parser.
chip_nr(→ pyparsing.ParserElement)	Returns a chip number parser.
fileinput(→ pyparsing.ParserElement)	Returns a fileinput parser.
decimal(→ pyparsing.ParserElement)	Returns a decimal parser.
range_field(→ pyparsing.ParserElement)	Generic range field parser.
integer_range_field(→ pyparsing.ParserElement)	Returns an integer range parser.
decimal_range_field(→ pyparsing.ParserElement)	Returns a decimal range parser.
currency(→ pyparsing.ParserElement)	Returns a currency parser.
pricing(→ pyparsing.ParserElement)	Returns a pricing parser.
discount(→ pyparsing.ParserElement)	Returns a discount parser.
marker_box(→ pyparsing.ParserElement)	Returns a marker box:
radio(→ pyparsing.ParserElement)	Returns a radio parser:
checkbox(→ pyparsing.ParserElement)	Returns a checkbox parser:
fieldset_title(→ pyparsing.ParserElement)	A fieldset title parser. Fieldset titles are just like headings in
field_identifier(→ pyparsing.ParserElement)	Returns a field identifier parser:
field_help_identifier(→ pyparsing.ParserElement)	Returns parser for a field help comment following a field/fieldset:

Module Contents

form.parser.grammar.printables

form.parser.grammar.text

form.parser.grammar.numeric

form.parser.grammar.word_re = '[]+'

form.parser.grammar.no_printable_or_whitespace_re = '[^]'

form.parser.grammar.text_without_re(characters: str) → str

Returns a re group for text without the given characters.

form.parser.grammar.text_without(characters: str) → pyparsing.Word

Returns all printable text without the given characters.

form.parser.grammar.matches(character: str) → collections.abc.Callable[[pyparsing.results.ParseResults], bool]

Returns true if the given character matches the token.

form.parser.grammar.literal[T](value: T) → collections.abc.Callable[[pyparsing.results.ParseResults], T]

“ Returns the given value, ignoring the tokens alltogether.

form.parser.grammar.as_int(tokens: pyparsing.results.ParseResults) → int | None

Converts the token to int if possible.

form.parser.grammar.as_joined_string(tokens: pyparsing.results.ParseResults) → str

Joins the given tokens into a single string.

form.parser.grammar.as_decimal(tokens: pyparsing.results.ParseResults) → decimal.Decimal | None

Converts the token to decimal if possible.

form.parser.grammar.as_uppercase(tokens: pyparsing.results.ParseResults) → str | None

Converts the token to uppercase if possible.

form.parser.grammar.as_integer_range(tokens: pyparsing.results.ParseResults) → range | None

Converts the token to an integer range if possible.

form.parser.grammar.as_decimal_range(tokens: pyparsing.results.ParseResults) → onegov.form.utils.decimal_range | None

Converts the token to a decimal range if possible.

form.parser.grammar.as_regex(tokens: pyparsing.results.ParseResults) → re.Pattern[str] | None

Converts the token to a working regex if possible.

form.parser.grammar.as_date(instring: str, loc: int, tokens: pyparsing.results.ParseResults) → datetime.date | None

Converts the token to a date if possible.

form.parser.grammar.is_valid_date_range(instring: str, loc: int, tokens: pyparsing.results.ParseResults) → pyparsing.results.ParseResults

Checks if the date range is valid

form.parser.grammar.is_valid_currency(instring: str, loc: int, tokens: pyparsing.results.ParseResults) → str | None

class form.parser.grammar.RelativeDate(grain: Literal['days', 'weeks', 'months', 'years'] | None = None, offset: int = 0)

Bases: dateutil.relativedelta.relativedelta

The relativedelta type is designed to be applied to an existing datetime and can replace specific components of that datetime, or represents an interval of time.

It is based on the specification of the excellent work done by M.-A. Lemburg in his mx.DateTime extension. However, notice that this type does NOT implement the same algorithm as his work. Do NOT expect it to behave like mx.DateTime’s counterpart.

There are two different ways to build a relativedelta instance. The first one is passing it two date/datetime classes:

relativedelta(datetime1, datetime2)

The second one is passing it any number of the following keyword arguments:

relativedelta(arg1=x,arg2=y,arg3=z...)

year, month, day, hour, minute, second, microsecond:
    Absolute information (argument is singular); adding or subtracting a
    relativedelta with absolute information does not perform an arithmetic
    operation, but rather REPLACES the corresponding value in the
    original datetime with the value(s) in relativedelta.

years, months, weeks, days, hours, minutes, seconds, microseconds:
    Relative information, may be negative (argument is plural); adding
    or subtracting a relativedelta with relative information performs
    the corresponding arithmetic operation on the original datetime value
    with the information in the relativedelta.

weekday:
    One of the weekday instances (MO, TU, etc) available in the
    relativedelta module. These instances may receive a parameter N,
    specifying the Nth weekday, which could be positive or negative
    (like MO(+1) or MO(-2)). Not specifying it is the same as specifying
    +1. You can also use an integer, where 0=MO. This argument is always
    relative e.g. if the calculated date is already Monday, using MO(1)
    or MO(-1) won't change the day. To effectively make it absolute, use
    it in combination with the day argument (e.g. day=1, MO(1) for first
    Monday of the month).

leapdays:
    Will add given days to the date found, if year is a leap
    year, and the date found is post 28 of february.

yearday, nlyearday:
    Set the yearday or the non-leap year day (jump leap days).
    These are converted to day/month/leapdays information.

There are relative and absolute forms of the keyword arguments. The plural is relative, and the singular is absolute. For each argument in the order below, the absolute form is applied first (by setting each attribute to that value) and then the relative form (by adding the value to the attribute).

The order of attributes considered when this relativedelta is added to a datetime is:

1. Year

2. Month

3. Day

4. Hours

5. Minutes

6. Seconds

7. Microseconds

Finally, weekday is applied, using the rule described above.

For example

>>> from datetime import datetime
>>> from dateutil.relativedelta import relativedelta, MO
>>> dt = datetime(2018, 4, 9, 13, 37, 0)
>>> delta = relativedelta(hours=25, day=1, weekday=MO(1))
>>> dt + delta
datetime.datetime(2018, 4, 2, 14, 37)

First, the day is set to 1 (the first of the month), then 25 hours are added, to get to the 2nd day and 14th hour, finally the weekday is applied, but since the 2nd is already a Monday there is no effect.

grain = None

offset = 0

serialize() → dict[str, Any]

property approximate_total_days: float

__lt__(other: RelativeDate) → bool

__format__(format_spec: str) → str

__str__() → str

classmethod __get_pydantic_core_schema__(source_type: Any, handler: pydantic.GetCoreSchemaHandler) → pydantic_core.CoreSchema

classmethod __get_pydantic_json_schema__(_schema: pydantic_core.CoreSchema, handler: pydantic.GetJsonSchemaHandler) → pydantic.json_schema.JsonSchemaValue

form.parser.grammar.as_relative_date(tokens: pyparsing.results.ParseResults) → RelativeDate | None

form.parser.grammar.unwrap(tokens: pyparsing.results.ParseResults) → Any | None

Unwraps grouped tokens.

form.parser.grammar.tag(**tags: str) → collections.abc.Callable[[pyparsing.results.ParseResults], None]

Takes the given tags and applies them to the token.

form.parser.grammar.with_whitespace_inside(expr: pyparsing.ParserElement) → pyparsing.Combine

Returns an expression that allows for whitespace inside, but not outside the expression.

form.parser.grammar.enclosed_in(expr: pyparsing.ParserElement, characters: str) → pyparsing.ParserElement

Wraps the given expression in the given characters.

form.parser.grammar.number_enclosed_in(characters: str) → pyparsing.ParserElement

Wraps numers in the given characters, making sure the result is an int.

form.parser.grammar.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.

form.parser.grammar.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]
[ ]

form.parser.grammar.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}

form.parser.grammar.textarea() → pyparsing.ParserElement

Returns a textarea parser.

Example:

...[5]

The number defines the number of rows.

form.parser.grammar.code() → pyparsing.ParserElement

Returns a code textfield with a specified syntax.

Currently only markdown is supported.

Example:

<markdown>

form.parser.grammar.password() → pyparsing.ParserElement

Returns a password field parser.

Example:

***

form.parser.grammar.email() → pyparsing.ParserElement

Returns an email field parser.

Example:

@@@

form.parser.grammar.url() → pyparsing.ParserElement

Returns an url field parser.

Example:

http://
https://

form.parser.grammar.video_url() → pyparsing.ParserElement

Returns an video url field parser.

Example:

video-url

form.parser.grammar.absolute_date() → pyparsing.ParserElement

Returns an absolute date parser.

Example:

2020.10.10

form.parser.grammar.relative_date() → pyparsing.ParserElement

Returns a relative date parser.

Example:

+1 days
-4 weeks
0 years

form.parser.grammar.valid_date_range() → pyparsing.ParserElement

Returns a valid date range parser.

Example:

(..today)
(2010.01.01..2020.01.01)
(-2 weeks..+4 months)

form.parser.grammar.date() → pyparsing.ParserElement

Returns a date parser.

Example:

YYYY.MM.DD

form.parser.grammar.datetime() → pyparsing.ParserElement

Returns a datetime parser.

Example:

YYYY.MM.DD HH:MM

form.parser.grammar.time() → pyparsing.ParserElement

Returns a time parser.

Example:

HH:MM

form.parser.grammar.stdnum() → pyparsing.ParserElement

Returns an stdnum parser.

Example:

# iban

form.parser.grammar.chip_nr() → pyparsing.ParserElement

Returns a chip number parser.

Example:

chip-nr

form.parser.grammar.fileinput() → pyparsing.ParserElement

Returns a fileinput parser.

For all kindes of files:

*.*

For specific files:

*.pdf|*.doc

For multiple file upload:

*.pdf (multiple)

form.parser.grammar.decimal() → pyparsing.ParserElement

Returns a decimal parser.

Decimal point is ‘.’.

For example:

0.00 123 11.1 -10.0

form.parser.grammar.range_field(value_expression: pyparsing.ParserElement, parse_action: collections.abc.Callable[[pyparsing.results.ParseResults], Any], type: str) → pyparsing.ParserElement

Generic range field parser.

form.parser.grammar.integer_range_field() → pyparsing.ParserElement

Returns an integer range parser.

form.parser.grammar.decimal_range_field() → pyparsing.ParserElement

Returns a decimal range parser.

form.parser.grammar.currency() → pyparsing.ParserElement

Returns a currency parser.

For example:

chf USD Cny

form.parser.grammar.pricing() → pyparsing.ParserElement

Returns a pricing parser.

For example:

(10.0 CHF) (0 usd!) (-0.50 Cny)

form.parser.grammar.discount() → pyparsing.ParserElement

Returns a discount parser.

For example:

(100%) (-25 %) (33.3%)

form.parser.grammar.marker_box(characters: str) → pyparsing.ParserElement

Returns a marker box:

Example:

(x) Male
[x] Female
{x} What?

form.parser.grammar.radio() → pyparsing.ParserElement

Returns a radio parser:

Example::

(x) Male ( ) Female

form.parser.grammar.checkbox() → pyparsing.ParserElement

Returns a checkbox parser:

Example::

[x] Male [ ] Female

form.parser.grammar.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):

# …

form.parser.grammar.field_identifier() → pyparsing.ParserElement

Returns a field identifier parser:

Example:

My field *

form.parser.grammar.field_help_identifier() → pyparsing.ParserElement

Returns parser for a field help comment following a field/fieldset:

General Example:

<< Help text for My Field >>