npe2 0.7.9__py3-none-any.whl → 0.8.0rc0__py3-none-any.whl

npe2/manifest/_package_metadata.py

@@ -1,38 +1,32 @@
 from importlib import metadata
-from typing import Dict, List, Literal, Optional, Union
+from typing import Literal
 
-from npe2._pydantic_compat import (
-    SHAPE_LIST,
-    BaseModel,
-    Extra,
-    Field,
-    constr,
-    root_validator,
-)
+from pydantic import BaseModel, ConfigDict, Field, constr, model_validator
+
+from npe2._pydantic_util import is_list_type
 
 # https://packaging.python.org/specifications/core-metadata/
 
 MetadataVersion = Literal["1.0", "1.1", "1.2", "2.0", "2.1", "2.2", "2.3"]
 _alphanum = "[a-zA-Z0-9]"
-PackageName = constr(regex=f"^{_alphanum}[a-zA-Z0-9._-]*{_alphanum}$")
+PackageName = constr(pattern=f"^{_alphanum}[a-zA-Z0-9._-]*{_alphanum}$")
 
 
 class PackageMetadata(BaseModel):
     """Pydantic model for standard python package metadata.
 
     https://www.python.org/dev/peps/pep-0566/
-    https://packaging.python.org/specifications/core-metadata/
+    https://packaging.python.org/pattern/core-metadata/
 
     The `importlib.metadata` provides the `metadata()` function,
     but it returns a somewhat awkward `email.message.Message` object.
     """
 
-    class Config:
-        extra = Extra.ignore
+    model_config = ConfigDict(extra="ignore")
 
     # allow str as a fallback in case the metata-version specification has been
     # updated and we haven't updated the code yet
-    metadata_version: Union[MetadataVersion, str] = Field(
+    metadata_version: MetadataVersion | str = Field(
         "1.0", description="Version of the file format"
     )
     name: PackageName = Field(  # type: ignore
@@ -48,34 +42,34 @@ class PackageMetadata(BaseModel):
         description="A string containing the distribution's version number. "
         "This field must be in the format specified in PEP 440.",
     )
-    dynamic: Optional[List[str]] = Field(
+    dynamic: list[str] | None = Field(
         None,
         description="A string containing the name of another core metadata "
         "field. The field names Name and Version may not be specified in this field.",
         min_ver="2.2",
     )
-    platform: Optional[List[str]] = Field(
+    platform: list[str] | None = Field(
         None,
         description="A Platform specification describing an operating system "
         "supported by the distribution which is not listed in the “Operating System” "
         "Trove classifiers. See “Classifier” below.",
     )
-    supported_platform: Optional[List[str]] = Field(
+    supported_platform: list[str] | None = Field(
         None,
         description="Binary distributions containing a PKG-INFO file will use the "
         "Supported-Platform field in their metadata to specify the OS and CPU for "
         "which the binary distribution was compiled",
         min_ver="1.1",
     )
-    summary: Optional[str] = Field(
+    summary: str | None = Field(
         None, description="A one-line summary of what the distribution does."
     )
-    description: Optional[str] = Field(
+    description: str | None = Field(
         None,
         description="A longer description of the distribution that can "
         "run to several paragraphs.",
     )
-    description_content_type: Optional[str] = Field(
+    description_content_type: str | None = Field(
         None,
         description="A string stating the markup syntax (if any) used in the "
         "distribution's description, so that tools can intelligently render the "
@@ -83,45 +77,45 @@ class PackageMetadata(BaseModel):
         "text/plain, text/x-rst, text/markdown",
         min_ver="2.1",
     )
-    keywords: Optional[str] = Field(
+    keywords: str | None = Field(
         None,
         description="A list of additional keywords, separated by commas, to be used "
         "to assist searching for the distribution in a larger catalog.",
     )
-    home_page: Optional[str] = Field(
+    home_page: str | None = Field(
         None,
         description="A string containing the URL for the distribution's home page.",
     )
-    download_url: Optional[str] = Field(
+    download_url: str | None = Field(
         None,
         description="A string containing the URL from which THIS version of the "
         "distribution can be downloaded.",
         min_ver="1.1",
     )
-    author: Optional[str] = Field(
+    author: str | None = Field(
         None,
         description="A string containing the author's name at a minimum; "
         "additional contact information may be provided.",
     )
-    author_email: Optional[str] = Field(
+    author_email: str | None = Field(
         None,
         description="A string containing the author's e-mail address. It can contain "
         "a name and e-mail address in the legal forms for a RFC-822 From: header.",
     )
-    maintainer: Optional[str] = Field(
+    maintainer: str | None = Field(
         None,
         description="A string containing the maintainer's name at a minimum; "
         "additional contact information may be provided.",
         min_ver="1.2",
     )
-    maintainer_email: Optional[str] = Field(
+    maintainer_email: str | None = Field(
         None,
         description="A string containing the maintainer's e-mail address. It can "
         "contain a name and e-mail address in the legal forms for a "
         "RFC-822 From: header.",
         min_ver="1.2",
     )
-    license: Optional[str] = Field(
+    license: str | None = Field(
         None,
         description="Text indicating the license covering the distribution where the "
         "license is not a selection from the “License” Trove classifiers. See "
@@ -129,21 +123,21 @@ class PackageMetadata(BaseModel):
         "version of a license which is named via the Classifier field, or to "
         "indicate a variation or exception to such a license.",
     )
-    classifier: Optional[List[str]] = Field(
+    classifier: list[str] | None = Field(
         None,
         description="Each entry is a string giving a single classification value for "
         "the distribution. Classifiers are described in PEP 301, and the Python "
         "Package Index publishes a dynamic list of currently defined classifiers.",
         min_ver="1.1",
     )
-    requires_dist: Optional[List[str]] = Field(
+    requires_dist: list[str] | None = Field(
         None,
         description="The field format specification was relaxed to accept the syntax "
         "used by popular publishing tools. Each entry contains a string naming some "
         "other distutils project required by this distribution.",
         min_ver="1.2",
     )
-    requires_python: Optional[str] = Field(
+    requires_python: str | None = Field(
         None,
         description="This field specifies the Python version(s) that the distribution "
         "is guaranteed to be compatible with. Installation tools may look at this "
@@ -151,7 +145,7 @@ class PackageMetadata(BaseModel):
         "The value must be in the format specified in Version specifiers (PEP 440).",
         min_ver="1.2",
     )
-    requires_external: Optional[List[str]] = Field(
+    requires_external: list[str] | None = Field(
         None,
         description="The field format specification was relaxed to accept the syntax "
         "used by popular publishing tools. Each entry contains a string describing "
@@ -160,13 +154,13 @@ class PackageMetadata(BaseModel):
         "has no semantics which are meaningful to the distutils distribution.",
         min_ver="1.2",
     )
-    project_url: Optional[List[str]] = Field(
+    project_url: list[str] | None = Field(
         None,
         description="A string containing a browsable URL for the project and a label "
         "for it, separated by a comma.",
         min_ver="1.2",
     )
-    provides_extra: Optional[List[str]] = Field(
+    provides_extra: list[str] | None = Field(
         None,
         description="A string containing the name of an optional feature. Must be a "
         "valid Python identifier. May be used to make a dependency conditional on "
@@ -175,19 +169,18 @@ class PackageMetadata(BaseModel):
     )
 
     # rarely_used
-    provides_dist: Optional[List[str]] = Field(None, min_ver="1.2")
-    obsoletes_dist: Optional[List[str]] = Field(None, min_ver="1.2")
+    provides_dist: list[str] | None = Field(None, min_ver="1.2")
+    obsoletes_dist: list[str] | None = Field(None, min_ver="1.2")
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
+    @classmethod
     def _validate_root(cls, values):
         if "metadata_version" not in values:
-            fields = cls.__fields__
-            mins = {
-                fields[n].field_info.extra.get("min_ver", "1.0")
-                for n in values
-                if n in fields
-            }
-            values["metadata_version"] = str(max(float(x) for x in mins))
+            min_vers = {"1.0"}
+            for n, info in cls.model_fields.items():
+                if n in values and info.json_schema_extra is not None:
+                    min_vers.add(info.json_schema_extra.get("min_ver", "1.0"))
+            values["metadata_version"] = str(max(float(x) for x in min_vers))
         return values
 
     @classmethod
@@ -200,8 +193,8 @@ class PackageMetadata(BaseModel):
     @classmethod
     def from_dist_metadata(cls, meta: "metadata.PackageMetadata") -> "PackageMetadata":
         """Generate PackageMetadata from importlib.metadata.PackageMetdata."""
-        manys = [f.name for f in cls.__fields__.values() if f.shape == SHAPE_LIST]
-        d: Dict[str, Union[str, List[str]]] = {}
+        manys = [n for n, f in cls.model_fields.items() if is_list_type(f.annotation)]
+        d: dict[str, str | list[str]] = {}
         # looks like py3.10 changed the public protocol of metadata.PackageMetadata
         # and they don't want you to rely on the Mapping interface... however, the
         # __iter__ method doesn't iterate key value pairs, just keys, and I can't figure
@@ -213,7 +206,7 @@ class PackageMetadata(BaseModel):
                 d.setdefault(key, []).append(value)  # type: ignore
             else:
                 d[key] = value
-        return cls.parse_obj(d)
+        return cls.model_validate(d)
 
     def __hash__(self) -> int:
         return id(self)

npe2/manifest/contributions/_commands.py

@@ -1,6 +1,9 @@
-from typing import TYPE_CHECKING, Any, Optional, Union
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Annotated, Any
+
+from pydantic import AfterValidator, BaseModel, ConfigDict, Field
 
-from npe2._pydantic_compat import BaseModel, Extra, Field, validator
 from npe2.manifest import _validators
 from npe2.types import PythonName
 
@@ -33,7 +36,7 @@ class CommandContribution(BaseModel):
     ```
     """
 
-    id: str = Field(
+    id: Annotated[str, AfterValidator(_validators.command_id)] = Field(
         ...,
         description="A unique identifier used to reference this command. While this may"
         " look like a python fully qualified name this does *not* refer to a python "
@@ -41,7 +44,6 @@ class CommandContribution(BaseModel):
         "the name of the package, and include only alphanumeric characters, plus "
         "dashes and underscores.",
     )
-    _valid_id = validator("id", allow_reuse=True)(_validators.command_id)
 
     title: str = Field(
         ...,
@@ -49,26 +51,27 @@ class CommandContribution(BaseModel):
         "for example, when searching in a command palette. Examples: 'Generate lily "
         "sample', 'Read tiff image', 'Open gaussian blur widget'. ",
     )
-    python_name: Optional[PythonName] = Field(
+    python_name: (
+        Annotated[PythonName, AfterValidator(_validators.python_name)] | None
+    ) = Field(
         None,
         description="Fully qualified name to a callable python object "
         "implementing this command. This usually takes the form of "
         "`{obj.__module__}:{obj.__qualname__}` "
         "(e.g. `my_package.a_module:some_function`)",
     )
-    _valid_pyname = validator("python_name", allow_reuse=True)(_validators.python_name)
 
-    short_title: Optional[str] = Field(
+    short_title: str | None = Field(
         None,
         description="Short title by which the command is represented in "
         "the UI. Menus pick either `title` or `short_title` depending on the context "
         "in which they show commands.",
     )
-    category: Optional[str] = Field(
+    category: str | None = Field(
         None,
         description="Category string by which the command may be grouped in the UI.",
     )
-    icon: Optional[Union[str, Icon]] = Field(
+    icon: str | Icon | None = Field(
         None,
         description="Icon used to represent this command in the UI, on "
         "buttons or in menus. These may be [superqt](https://github.com/napari/superqt)"
@@ -76,7 +79,7 @@ class CommandContribution(BaseModel):
         "expected to depend on any fonticon libraries they use, e.g "
         "[fonticon-fontawesome6](https://github.com/tlambert03/fonticon-fontawesome6).",
     )
-    enablement: Optional[str] = Field(
+    enablement: str | None = Field(
         None,
         description=(
             "Expression which must evaluate as true to enable the command in the UI "
@@ -85,14 +88,13 @@ class CommandContribution(BaseModel):
         ),
     )
 
-    class Config:
-        extra = Extra.forbid
+    model_config = ConfigDict(extra="forbid", validate_assignment=True)
 
     def exec(
         self,
         args: tuple = (),
-        kwargs: Optional[dict] = None,
-        _registry: Optional["CommandRegistry"] = None,
+        kwargs: dict | None = None,
+        _registry: CommandRegistry | None = None,
     ) -> Any:
         if kwargs is None:
             kwargs = {}

npe2/manifest/contributions/_configuration.py

@@ -1,6 +1,6 @@
-from typing import Any, Dict, List, Literal, Optional, Union
+from typing import Annotated, Any, Literal
 
-from npe2._pydantic_compat import BaseModel, Field, conlist, root_validator, validator
+from pydantic import BaseModel, BeforeValidator, Field, conlist, model_validator
 
 from ._json_schema import (
     Draft07JsonSchema,
@@ -18,21 +18,23 @@ class ConfigurationProperty(Draft07JsonSchema):
     https://json-schema.org/understanding-json-schema/reference/index.html
     """
 
-    type: Union[JsonType, JsonTypeArray] = Field(
-        None,
-        description="The type of this variable. Either JSON Schema type names ('array',"
-        " 'boolean', 'object', ...) or python type names ('list', 'bool', 'dict', ...) "
-        "may be used, but they will be coerced to JSON Schema types. Numbers, strings, "
-        "and booleans will be editable in the UI, other types (lists, dicts) *may* be "
-        "editable in the UI depending on their content, but maby will only be editable "
-        "as text in the napari settings file. For boolean entries, the description "
-        "(or markdownDescription) will be used as the label for the checkbox.",
+    type: Annotated[JsonType | JsonTypeArray, BeforeValidator(_coerce_type_name)] = (
+        Field(
+            None,
+            description="The type of this variable. Either JSON Schema type names "
+            "('array', 'boolean', 'object', ...) or python type names ('list', 'bool', "
+            "'dict', ...) may be used, but they will be coerced to JSON Schema types. "
+            "Numbers, strings, and booleans will be editable in the UI, other types "
+            "(lists, dicts) *may* be editable in the UI depending on their content, "
+            "but maby will only be editable as text in the napari settings file. For "
+            "boolean entries, the description (or markdownDescription) will be used as"
+            " the label for the checkbox.",
+        )
     )
-    _coerce_type_name = validator("type", pre=True, allow_reuse=True)(_coerce_type_name)
 
     default: Any = Field(None, description="The default value for this property.")
 
-    description: Optional[str] = Field(
+    description: str | None = Field(
         None,
         description="Your `description` appears after the title and before the input "
         "field, except for booleans, where the description is used as the label for "
@@ -45,12 +47,12 @@ class ConfigurationProperty(Draft07JsonSchema):
         "plain text, set this value to `plain`.",
     )
 
-    enum: Optional[conlist(Any, min_items=1, unique_items=True)] = Field(  # type: ignore
+    enum: conlist(Any, min_length=1) | None = Field(  # type: ignore
         None,
         description="A list of valid options for this field. If you provide this field,"
         "the settings UI will render a dropdown menu.",
     )
-    enum_descriptions: List[str] = Field(
+    enum_descriptions: list[str] = Field(
         default_factory=list,
         description="If you provide a list of items under the `enum` field, you may "
         "provide `enum_descriptions` to add descriptive text for each enum.",
@@ -62,7 +64,7 @@ class ConfigurationProperty(Draft07JsonSchema):
         "plain text, set this value to `plain`.",
     )
 
-    deprecation_message: Optional[str] = Field(
+    deprecation_message: str | None = Field(
         None,
         description="If you set deprecationMessage, the setting will get a warning "
         "underline with your specified message. It won't show up in the settings "
@@ -80,7 +82,7 @@ class ConfigurationProperty(Draft07JsonSchema):
         description="By default, string settings will be rendered with a single-line "
         "editor. To render with a multi-line editor, set this value to `multiline`.",
     )
-    order: Optional[int] = Field(
+    order: int | None = Field(
         None,
         description="When specified, gives the order of this setting relative to other "
         "settings within the same category. Settings with an order property will be "
@@ -88,14 +90,14 @@ class ConfigurationProperty(Draft07JsonSchema):
         " will be placed in alphabetical order.",
     )
 
-    pattern_error_message: Optional[str] = Field(
+    pattern_error_message: str | None = Field(
         None,
         description="When restricting string types to a given regular expression with "
         "the `pattern` field, this field may be used to provide a custom error when "
         "the pattern does not match.",
     )
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
     def _validate_root(cls, values):
         values = super()._validate_root(values)
 
@@ -135,7 +137,7 @@ class ConfigurationContribution(BaseModel):
         '"Plugin", "Configuration", and "Settings" are redundant and should not be'
         "used in your title.",
     )
-    properties: Dict[str, ConfigurationProperty] = Field(
+    properties: dict[str, ConfigurationProperty] = Field(
         ...,
         description="Configuration properties. In the settings UI, your configuration "
         "key will be used to namespace and construct a title. Though a plugin can "

npe2/manifest/contributions/_contributions.py

@@ -1,6 +1,4 @@
-from typing import Dict, List, Optional
-
-from npe2._pydantic_compat import BaseModel, Field, validator
+from pydantic import BaseModel, Field, field_validator
 
 from ._commands import CommandContribution
 from ._configuration import ConfigurationContribution
@@ -30,13 +28,13 @@ __all__ = [
 
 
 class ContributionPoints(BaseModel):
-    commands: Optional[List[CommandContribution]]
-    readers: Optional[List[ReaderContribution]]
-    writers: Optional[List[WriterContribution]]
-    widgets: Optional[List[WidgetContribution]]
-    sample_data: Optional[List[SampleDataContribution]]
-    themes: Optional[List[ThemeContribution]]
-    menus: Dict[str, List[MenuItem]] = Field(
+    commands: list[CommandContribution] | None = None
+    readers: list[ReaderContribution] | None = None
+    writers: list[WriterContribution] | None = None
+    widgets: list[WidgetContribution] | None = None
+    sample_data: list[SampleDataContribution] | None = None
+    themes: list[ThemeContribution] | None = None
+    menus: dict[str, list[MenuItem]] = Field(
         default_factory=dict,
         description="Add menu items to existing napari menus."
         "A menu item can be a command, such as open a widget, or a submenu."
@@ -44,10 +42,10 @@ class ContributionPoints(BaseModel):
         "This allows you to organize your plugin's contributions within"
         "napari's menu structure.",
     )
-    submenus: Optional[List[SubmenuContribution]]
-    keybindings: Optional[List[KeyBindingContribution]] = Field(None, hide_docs=True)
+    submenus: list[SubmenuContribution] | None = None
+    keybindings: list[KeyBindingContribution] | None = Field(None, hide_docs=True)
 
-    configuration: List[ConfigurationContribution] = Field(
+    configuration: list[ConfigurationContribution] = Field(
         default_factory=list,
         hide_docs=True,
         description="Configuration options for this plugin."
@@ -58,6 +56,7 @@ class ContributionPoints(BaseModel):
         "keys will be used for the submenu entry names.",
     )
 
-    @validator("configuration", pre=True)
+    @field_validator("configuration", mode="before")
+    @classmethod
     def _to_list(cls, v):
         return v if isinstance(v, list) else [v]

npe2/manifest/contributions/_icon.py

@@ -1,8 +1,6 @@
-from typing import Optional
-
-from npe2._pydantic_compat import BaseModel
+from pydantic import BaseModel
 
 
 class Icon(BaseModel):
-    light: Optional[str] = None
-    dark: Optional[str] = None
+    light: str | None = None
+    dark: str | None = None