Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ repos:
- id: ruff-check
priority: 5
args: ["--fix", "--unsafe-fixes", "--exit-non-zero-on-fix"]
- repo: https://github.com/henryiii/flake8-lazy
rev: 7f268b3b3aaf7feca756ca610e37971382976365 # frozen: v0.11.0
hooks:
- id: flake8-lazy
priority: 4
files: ^src/platformdirs/
exclude: ^src/platformdirs/(android|unix)\.py$ # cache resets and patch targets require eager imports
- repo: https://github.com/gaborbernat/simplint-pre-commit
rev: "d14a8917a5f578a176baf72ab9ee76314558769f" # frozen: v0.12.3
hooks:
Expand Down
1 change: 1 addition & 0 deletions docs/changelog/+lazy-imports.performance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Defer eligible imports on Python 3.15 while keeping platform selection and cache-sensitive imports eager.
9 changes: 9 additions & 0 deletions src/platformdirs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@

from __future__ import annotations

__lazy_modules__ = [
f"{__spec__.parent}.api", # ty: ignore[missing-union-attribute] # imported modules have a spec
f"{__spec__.parent}.ios", # ty: ignore[missing-union-attribute] # imported modules have a spec
f"{__spec__.parent}.macos", # ty: ignore[missing-union-attribute] # imported modules have a spec
f"{__spec__.parent}.unix", # ty: ignore[missing-union-attribute] # imported modules have a spec
f"{__spec__.parent}.version", # ty: ignore[missing-union-attribute] # imported modules have a spec
f"{__spec__.parent}.windows", # ty: ignore[missing-union-attribute] # imported modules have a spec
]

import os
import sys

Expand Down
2 changes: 2 additions & 0 deletions src/platformdirs/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

from __future__ import annotations

__lazy_modules__ = ["platformdirs"]

from platformdirs import PlatformDirs, __version__

TYPE_CHECKING = False
Expand Down
2 changes: 2 additions & 0 deletions src/platformdirs/_android.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

from __future__ import annotations

__lazy_modules__ = ["contextlib"]

import re
import sys
from contextlib import suppress
Expand Down
6 changes: 6 additions & 0 deletions src/platformdirs/_runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

from __future__ import annotations

__lazy_modules__ = [
"pathlib",
"warnings",
f"{__spec__.parent}.api", # ty: ignore[missing-union-attribute] # imported modules have a spec
]

import os
import stat
import sys
Expand Down
6 changes: 6 additions & 0 deletions src/platformdirs/_xdg.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

from __future__ import annotations

__lazy_modules__ = [
"contextlib",
"pathlib",
f"{__spec__.parent}._runtime", # ty: ignore[missing-union-attribute] # imported modules have a spec
]

import os
import posixpath
import sys
Expand Down
2 changes: 2 additions & 0 deletions src/platformdirs/android.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

from __future__ import annotations

__lazy_modules__ = ["contextlib"]

import os
import re
from contextlib import suppress
Expand Down
5 changes: 5 additions & 0 deletions src/platformdirs/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

from __future__ import annotations

__lazy_modules__ = [
"copy",
"pathlib",
]

import os
from abc import ABC, abstractmethod
from copy import copy
Expand Down
2 changes: 2 additions & 0 deletions src/platformdirs/ios.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

from __future__ import annotations

__lazy_modules__ = [f"{__spec__.parent}._xdg"] # ty: ignore[missing-union-attribute] # imported modules have a spec

from ._xdg import expand_user
from .api import PlatformDirsABC

Expand Down
5 changes: 5 additions & 0 deletions src/platformdirs/macos.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

from __future__ import annotations

__lazy_modules__ = [
"contextlib",
"pathlib",
]

import re
import stat
import sys
Expand Down
5 changes: 5 additions & 0 deletions src/platformdirs/testing.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

from __future__ import annotations

__lazy_modules__ = [
"pathlib",
f"{__spec__.parent}.api", # ty: ignore[missing-union-attribute] # imported modules have a spec
]

from contextlib import contextmanager
from pathlib import Path

Expand Down
6 changes: 6 additions & 0 deletions src/platformdirs/unix.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

from __future__ import annotations

__lazy_modules__ = [
"contextlib",
"pathlib",
"tempfile",
]

import os
import posixpath
import re
Expand Down
6 changes: 6 additions & 0 deletions src/platformdirs/windows.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

from __future__ import annotations

__lazy_modules__ = [
"pathlib",
"string",
f"{__spec__.parent}._xdg", # ty: ignore[missing-union-attribute] # imported modules have a spec
]

import ntpath
import os
import string
Expand Down
Loading