Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove requirement for setuptools.pkg_resources #5845

Merged
merged 30 commits into from
Nov 1, 2021
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
a73a78a
remove requirement for setuptools.pkg_resources
marscher Oct 7, 2021
9d14a01
doh
marscher Oct 7, 2021
6104a05
doh2
marscher Oct 7, 2021
d500090
doh3, no reraise for fallback version number
marscher Oct 7, 2021
7537b33
black formatting
marscher Oct 7, 2021
4dcc371
ordering
marscher Oct 7, 2021
2fc6537
all this lifetime wasted by fucking linting tools
marscher Oct 7, 2021
b482d68
precommit
marscher Oct 7, 2021
b2f1ad2
unconditionally depend on importlib-metadata [ci skip]
marscher Oct 27, 2021
25cb017
follow up
marscher Oct 27, 2021
9666401
import import_libmeta (unconditionally); rename pkg_entrypoints
marscher Oct 27, 2021
becf45e
Revert "unconditionally depend on importlib-metadata [ci skip]"
marscher Oct 27, 2021
a21485b
first try importlib.metadata (stdlib), then fallback to importlib_met…
marscher Oct 27, 2021
2310041
linting
marscher Oct 27, 2021
7ab694f
minor [ci skip]
marscher Oct 27, 2021
60b4237
broad exception clause?
marscher Oct 28, 2021
6a377ac
use importlib.resources read_binary to read html formatting files
marscher Oct 28, 2021
a9e695f
update changelog [ci skip]
marscher Oct 28, 2021
0ea3d65
Merge branch 'main' into remove_pkgresources
marscher Oct 28, 2021
e69e073
Update doc/whats-new.rst
marscher Oct 28, 2021
efc0bdb
Update doc/whats-new.rst
keewis Oct 28, 2021
5883ff8
remove setuptools from the minimum dependencies
keewis Oct 28, 2021
833b1cd
remove setuptools from the min deps CI and the installing docs
keewis Oct 28, 2021
d602190
ignore setuptools
keewis Oct 28, 2021
aeeb89f
decode the loaded resources
keewis Oct 28, 2021
5348287
add importlib_metadata to the list of dependencies
keewis Oct 28, 2021
4d2cc88
__init__: no no-redef
marscher Oct 29, 2021
dbd8108
Merge branch 'main' into remove_pkgresources
dcherian Oct 29, 2021
5ca4a94
Revert "__init__: no no-redef"
dcherian Oct 29, 2021
28c8485
[skip-ci] Update doc/getting-started-guide/installing.rst
dcherian Oct 29, 2021
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
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ python_requires = >=3.7
install_requires =
numpy >= 1.17
pandas >= 1.0
setuptools >= 40.4 # For pkg_resources
importlib-metadata; python_version < '3.8'

[options.extras_require]
io =
Expand Down
16 changes: 12 additions & 4 deletions xarray/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import pkg_resources

from . import testing, tutorial, ufuncs
from .backends.api import (
load_dataarray,
Expand Down Expand Up @@ -30,8 +28,18 @@
from .util.print_versions import show_versions

try:
__version__ = pkg_resources.get_distribution("xarray").version
except Exception:
from importlib.metadata import PackageNotFoundError as _PackageNotFoundError
from importlib.metadata import version as _version
except ImportError:
# if the fallback library is missing, we are doomed.
keewis marked this conversation as resolved.
Show resolved Hide resolved
from importlib_metadata import (
PackageNotFoundError as _PackageNotFoundError # type: ignore[no-redef]
)
from importlib_metadata import version as _version # type: ignore[no-redef]
marscher marked this conversation as resolved.
Show resolved Hide resolved

try:
__version__ = _version("xarray")
except (_PackageNotFoundError, Exception):
marscher marked this conversation as resolved.
Show resolved Hide resolved
# Local copy or not installed with setuptools.
# Disable minimum version checks on downstream libraries.
__version__ = "999"
Expand Down
46 changes: 27 additions & 19 deletions xarray/backends/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,27 @@
import itertools
import warnings

import pkg_resources

from .common import BACKEND_ENTRYPOINTS, BackendEntrypoint

STANDARD_BACKENDS_ORDER = ["netcdf4", "h5netcdf", "scipy"]
try:
from importlib.metadata import Distribution
except ImportError:
# if the fallback library is missing, we are doomed.
from importlib_metadata import Distribution # type: ignore[no-redef]


def remove_duplicates(pkg_entrypoints):
STANDARD_BACKENDS_ORDER = ["netcdf4", "h5netcdf", "scipy"]


def remove_duplicates(entrypoints):
# sort and group entrypoints by name
pkg_entrypoints = sorted(pkg_entrypoints, key=lambda ep: ep.name)
pkg_entrypoints_grouped = itertools.groupby(pkg_entrypoints, key=lambda ep: ep.name)
entrypoints = sorted(entrypoints, key=lambda ep: ep.name)
entrypoints_grouped = itertools.groupby(entrypoints, key=lambda ep: ep.name)
# check if there are multiple entrypoints for the same name
unique_pkg_entrypoints = []
for name, matches in pkg_entrypoints_grouped:
unique_entrypoints = []
for name, matches in entrypoints_grouped:
matches = list(matches)
unique_pkg_entrypoints.append(matches[0])
unique_entrypoints.append(matches[0])
matches_len = len(matches)
if matches_len > 1:
selected_module_name = matches[0].module_name
Expand All @@ -29,7 +33,7 @@ def remove_duplicates(pkg_entrypoints):
f"\n {all_module_names}.\n It will be used: {selected_module_name}.",
RuntimeWarning,
)
return unique_pkg_entrypoints
return unique_entrypoints


def detect_parameters(open_dataset):
Expand All @@ -50,12 +54,12 @@ def detect_parameters(open_dataset):
return tuple(parameters_list)


def backends_dict_from_pkg(pkg_entrypoints):
def backends_dict_from_pkg(entrypoints):
backend_entrypoints = {}
for pkg_ep in pkg_entrypoints:
name = pkg_ep.name
for entrypoint in entrypoints:
name = entrypoint.name
try:
backend = pkg_ep.load()
backend = entrypoint.load()
backend_entrypoints[name] = backend
except Exception as ex:
warnings.warn(f"Engine {name!r} loading failed:\n{ex}", RuntimeWarning)
Expand All @@ -80,13 +84,13 @@ def sort_backends(backend_entrypoints):
return ordered_backends_entrypoints


def build_engines(pkg_entrypoints):
def build_engines(entrypoints):
backend_entrypoints = {}
for backend_name, backend in BACKEND_ENTRYPOINTS.items():
if backend.available:
backend_entrypoints[backend_name] = backend
pkg_entrypoints = remove_duplicates(pkg_entrypoints)
external_backend_entrypoints = backends_dict_from_pkg(pkg_entrypoints)
entrypoints = remove_duplicates(entrypoints)
external_backend_entrypoints = backends_dict_from_pkg(entrypoints)
backend_entrypoints.update(external_backend_entrypoints)
backend_entrypoints = sort_backends(backend_entrypoints)
set_missing_parameters(backend_entrypoints)
Expand All @@ -95,8 +99,12 @@ def build_engines(pkg_entrypoints):

@functools.lru_cache(maxsize=1)
def list_engines():
pkg_entrypoints = pkg_resources.iter_entry_points("xarray.backends")
return build_engines(pkg_entrypoints)
entrypoints = (
entry_point
for entry_point in Distribution.from_name("xarray").entry_points
if entry_point.module == "xarray.backends"
)
return build_engines(entrypoints)


def guess_engine(store_spec):
Expand Down
15 changes: 9 additions & 6 deletions xarray/core/formatting_html.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
from functools import lru_cache, partial
from html import escape

import pkg_resources

from .formatting import inline_variable_array_repr, short_data_repr
from .options import _get_boolean_with_default

Expand All @@ -14,10 +12,15 @@
@lru_cache(None)
def _load_static_files():
"""Lazily load the resource files into memory the first time they are needed"""
return [
pkg_resources.resource_string("xarray", fname).decode("utf8")
for fname in STATIC_FILES
]
import pathlib

parent = pathlib.Path(__file__).parent / "../"
result = []
for fname in STATIC_FILES:
with open(parent / fname) as fh:
keewis marked this conversation as resolved.
Show resolved Hide resolved
result.append(fh.read().encode("utf8"))

return result


def short_data_repr_html(array):
Expand Down