Pydantic types

Pydantic is a validation library that provides a rich selection of useful types for command-line inputs.

The following commonly used Pydantic types can be used as type hints for Feud commands.

Important

This page only lists a subset of Pydantic types, i.e. those which would commonly be used as command-line inputs.

All Pydantic types (including those not listed on this page) are compatible with Feud.

Tip

All of the types listed on this page are easily accessible from the feud.typing module.

It is recommended to import the feud.typing module with an alias such as t for convenient short-hand use, e.g.

from feud import typing as t

t.PositiveInt  # pydantic.types.PositiveInt
t.FutureDatetime  # pydantic.types.FutureDatetime
t.conint  # pydantic.types.conint
t.IPvAnyAddress  # pydantic.networks.IPvAnyAddress

---

The version number indicates the minimum pydantic version required to use the type.

If this version requirement is not met, the type is not imported by Feud.

String types

• pydantic.types.ImportString (>= 2.0.3)

• pydantic.types.SecretStr (>= 2.0.3)

• pydantic.types.StrictStr (>= 2.0.3)

• pydantic.types.constr (>= 2.0.3)

Integer types

• pydantic.types.NegativeInt (>= 2.0.3)

• pydantic.types.NonNegativeInt (>= 2.0.3)

• pydantic.types.NonPositiveInt (>= 2.0.3)

• pydantic.types.PositiveInt (>= 2.0.3)

• pydantic.types.StrictInt (>= 2.0.3)

• pydantic.types.conint (>= 2.0.3)

Float types

• pydantic.types.FiniteFloat (>= 2.0.3)

• pydantic.types.NegativeFloat (>= 2.0.3)

• pydantic.types.NonNegativeFloat (>= 2.0.3)

• pydantic.types.NonPositiveFloat (>= 2.0.3)

• pydantic.types.PositiveFloat (>= 2.0.3)

• pydantic.types.StrictFloat (>= 2.0.3)

• pydantic.types.confloat (>= 2.0.3)

Sequence types

• pydantic.types.confrozenset (>= 2.0.3)

• pydantic.types.conlist (>= 2.0.3)

• pydantic.types.conset (>= 2.0.3)

Datetime types

• pydantic.types.AwareDatetime (>= 2.0.3)

• pydantic.types.FutureDate (>= 2.0.3)

• pydantic.types.FutureDatetime (>= 2.0.3)

• pydantic.types.NaiveDatetime (>= 2.0.3)

• pydantic.types.PastDate (>= 2.0.3)

• pydantic.types.PastDatetime (>= 2.0.3)

• pydantic.types.condate (>= 2.0.3)

Path types

• pydantic.types.DirectoryPath (>= 2.0.3)

• pydantic.types.FilePath (>= 2.0.3)

• pydantic.types.NewPath (>= 2.0.3)

Decimal type

• pydantic.types.condecimal (>= 2.0.3)

URL types

• pydantic.networks.AnyHttpUrl (>= 2.0.3)

• pydantic.networks.AnyUrl (>= 2.0.3)

• pydantic.networks.FileUrl (>= 2.0.3)

• pydantic.networks.HttpUrl (>= 2.0.3)

Email types

Important

In order to use email types, you must install Feud with the optional email-validator dependency (see here).

$ pip install feud[email]

• pydantic.networks.EmailStr (>= 2.0.3)

• pydantic.networks.NameEmail (>= 2.0.3)

Base-64 types

• pydantic.types.Base64Bytes (>= 2.0.3)

• pydantic.types.Base64Str (>= 2.0.3)

• pydantic.types.Base64UrlBytes (>= 2.4.0)

• pydantic.types.Base64UrlStr (>= 2.4.0)

Byte types

• pydantic.types.ByteSize (>= 2.0.3)

• pydantic.types.SecretBytes (>= 2.0.3)

• pydantic.types.StrictBytes (>= 2.0.3)

• pydantic.types.conbytes (>= 2.0.3)

JSON type

• pydantic.types.Json (>= 2.0.3)

• pydantic.types.JsonValue (>= 2.5.0)

IP address types

• pydantic.networks.IPvAnyAddress (>= 2.0.3)

• pydantic.networks.IPvAnyInterface (>= 2.0.3)

• pydantic.networks.IPvAnyNetwork (>= 2.0.3)

Database connection types

• pydantic.networks.AmqpDsn (>= 2.0.3)

• pydantic.networks.CockroachDsn (>= 2.0.3)

• pydantic.networks.KafkaDsn (>= 2.0.3)

• pydantic.networks.MariaDBDsn (>= 2.0.3)

• pydantic.networks.MongoDsn (>= 2.0.3)

• pydantic.networks.MySQLDsn (>= 2.0.3)

• pydantic.networks.PostgresDsn (>= 2.0.3)

• pydantic.networks.RedisDsn (>= 2.0.3)

UUID types

• pydantic.types.UUID1 (>= 2.0.3)

• pydantic.types.UUID3 (>= 2.0.3)

• pydantic.types.UUID4 (>= 2.0.3)

• pydantic.types.UUID5 (>= 2.0.3)

Boolean type

• pydantic.types.StrictBool (>= 2.0.3)

Other types

• pydantic.functional_validators.SkipValidation (>= 2.0.3)