Typing Stubs for pyRFC3339

2.0.1.20250825 · active · verified Thu Apr 16

types-pyrfc3339 provides high-quality static type annotations (typing stubs) for the pyRFC3339 library. pyRFC3339 itself is a Python library that parses and generates RFC 3339-compliant timestamps using Python's `datetime.datetime` objects. This stub package, currently at version 2.0.1.20250825, is automatically generated and released from the community-driven Typeshed repository, typically with daily updates to keep pace with changes in the runtime library.

Common errors

```
ModuleNotFoundError: No module named 'pyrfc3339'
```
cause The `pyRFC3339` runtime library is not installed, even though `types-pyrfc3339` might be.

fix Run `pip install pyrfc3339` to install the actual library that provides the functions.
```
mypy: Argument 1 to "generate" has incompatible type "str"; expected "datetime.datetime"
```
cause You are passing an incorrect type (e.g., `str`) to a function that expects a `datetime.datetime` object, as enforced by the `types-pyrfc3339` stubs.

fix Ensure the arguments passed to `pyrfc3339.generate` and `pyrfc3339.parse` match the expected types (e.g., `datetime.datetime` for `generate`, `str` for `parse`).

Warnings

gotcha Installing `types-pyrfc3339` does not install the `pyRFC3339` runtime library itself. You must install `pyRFC3339` separately for your code to execute. `types-pyrfc3339` only provides type information.
Fix: Ensure both `pip install pyrfc3339` and `pip install types-pyrfc3339` are run. The stub package alone provides no runnable code.
gotcha Version mismatches between `types-pyrfc3339` and `pyRFC3339` can lead to inaccurate type checking. Typeshed stubs are frequently updated, sometimes daily, and may reflect newer versions of the runtime library.
Fix: For critical projects, consider pinning both `pyRFC3339` and `types-pyrfc3339` to compatible versions. Regularly update both packages and re-run your type checker.
gotcha Do not attempt to import symbols directly from `types_pyrfc3339`. The stub package's name on PyPI (`types-pyrfc3339`) is for installation purposes only. Runtime imports should always be from the actual library: `from pyrfc3339 import ...`.
Fix: Always use `from pyrfc3339 import generate, parse` (or other symbols) for runtime code. The `types-*` prefix is an installation convention, not an import path.

Install

pip install types-pyrfc3339 Install typing stubs

Imports

generate
wrong:
```
from types_pyrfc3339 import generate
```
correct:
```
from pyrfc3339 import generate
```
The `types-pyrfc3339` package provides stubs for `pyrfc3339`. You import directly from the runtime library, `pyrfc3339`, not from the stub package name.
parse
wrong:
```
from types_pyrfc3339 import parse
```
correct:
```
from pyrfc3339 import parse
```
The `types-pyrfc3339` package provides stubs for `pyrfc3339`. You import directly from the runtime library, `pyrfc3339`, not from the stub package name.

Quickstart

This quickstart demonstrates basic usage of the `pyrfc3339` library for generating and parsing RFC 3339 timestamps. With `types-pyrfc3339` installed, a static type checker can verify the correctness of the types used in these operations, catching potential errors before runtime.

import datetime
from pyrfc3339 import generate, parse

# Get current UTC time to generate an RFC 3339 timestamp
now_utc = datetime.datetime.now(datetime.timezone.utc)
print(f"Current UTC datetime: {now_utc.isoformat()}")

# Generate RFC 3339 timestamp string
rfc3339_string = generate(now_utc)
print(f"Generated RFC 3339 string: {rfc3339_string}")

# Parse an RFC 3339 timestamp string back to a datetime object
some_rfc3339_string = "2023-10-27T10:30:00.123456Z"
parsed_dt = parse(some_rfc3339_string)
print(f"Parsed RFC 3339 string: {parsed_dt}")

# The presence of types-pyrfc3339 allows type checkers (e.g., Mypy) to validate arguments:
# For example, uncommenting the line below would trigger a type error:
# generate("not a datetime object")

view raw JSON →