vo-models 0.4.2.dev0__tar.gz → 0.4.3.dev0__tar.gz

{vo_models-0.4.2.dev0/vo_models.egg-info → vo_models-0.4.3.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: vo-models
-Version: 0.4.2.dev0
+Version: 0.4.3.dev0
 Summary: Pydantic data models for IVOA protocols
 Author-email: Joshua Fraustro <jfraustro@stsci.edu>, MAST Archive Developers <archive@stsci.edu>
 Project-URL: Homepage, https://github.com/spacetelescope/vo-models
@@ -28,6 +28,7 @@ Requires-Dist: furo; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
+Dynamic: license-file
 
 # vo-models
 
@@ -61,6 +62,8 @@ The following IVOA protocols are currently supported:
   - others
 - **VOResource version 1.1**
 - **TAPRegExt version 1.0**
+- **VORegistry 1.1**
+- **RegistryInterfaces version 1.0**
 
 You can read more about using these models in our documentation: https://vo-models.readthedocs.io/
 

{vo_models-0.4.2.dev0 → vo_models-0.4.3.dev0}/README.md

@@ -30,6 +30,8 @@ The following IVOA protocols are currently supported:
   - others
 - **VOResource version 1.1**
 - **TAPRegExt version 1.0**
+- **VORegistry 1.1**
+- **RegistryInterfaces version 1.0**
 
 You can read more about using these models in our documentation: https://vo-models.readthedocs.io/
 

{vo_models-0.4.2.dev0 → vo_models-0.4.3.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vo-models"
-version = "0.4.2.dev0"
+version = "0.4.3.dev0"
 authors = [
     {name = "Joshua Fraustro", email="jfraustro@stsci.edu"},
     {name = "MAST Archive Developers", email="archive@stsci.edu"}

vo_models-0.4.3.dev0/vo_models/registry_interfaces/__init__.py

@@ -0,0 +1,8 @@
+"""IVOA Registry Interfaces v1.0 Pydantic-XML models"""
+
+from vo_models.registry_interfaces.models import (Resource, VOResources)
+
+__all__ = [
+    "Resource",
+    "VOResources",
+]

vo_models-0.4.3.dev0/vo_models/registry_interfaces/models.py

@@ -0,0 +1,47 @@
+"""VORegistryInterfaces v1.0 Pydantic-XML models"""
+from pydantic import model_validator
+from pydantic_xml import BaseXmlModel, attr, element
+
+import vo_models.voresource as vr
+
+NSMAP = {
+    "ri": "http://www.ivoa.net/xml/RegistryInterface/v1.0",
+    "vr": "http://www.ivoa.net/xml/VOResource/v1.0",
+}
+
+
+class Resource(vr.Resource, ns="ri", nsmap=NSMAP):
+    """A description of a single resource."""
+
+
+class VOResources(BaseXmlModel):
+    """A container for one or more resource descriptions or identifier references to resources.
+
+    Parameters:
+        resource:
+            (element) - One or more resource descriptions.
+        identifier:
+            (element) - One or more identifier references to resources.
+        from:
+            (attribute) - The starting number of resources to return.
+        number_returned:
+            (attribute) - The number of resources returned in the response.
+        more:
+            (attribute) - Indicates whether there are more resources available.
+    """
+
+    resource: list[Resource] = element(tag="Resource", default=[])
+    identifier: list[vr.IdentifierURI] = element(tag="identifier", default=[])
+
+    # positive ints
+    from_: int = attr(name="from", alias="from", gt=0)
+    number_returned: int = attr(name="numberReturned", gt=0)
+    more: bool = attr(name="more")
+
+    @model_validator(mode="before")
+    @classmethod
+    def check_resource_or_identifier(cls, values):
+        """Ensure that either 'resource' or 'identifier' is provided."""
+        if values.get("resource") and values.get("identifier"):
+            raise ValueError("Either 'resource' or 'identifier' must be provided.")
+        return values

vo_models-0.4.3.dev0/vo_models/voregistry/__init__.py

@@ -0,0 +1,14 @@
+"""IVOA VORegistry-v1.1 pydantic-xml models"""
+
+from vo_models.voregistry.types import ExtensionSearchSupport, OptionalProtocol
+from vo_models.voregistry.models import Registry, Harvest, Search, OAIHTTP, OAISOAP
+
+__all__ = [
+    "ExtensionSearchSupport",
+    "OptionalProtocol",
+    "Registry",
+    "Harvest",
+    "Search",
+    "OAIHTTP",
+    "OAISOAP",
+]

vo_models-0.4.3.dev0/vo_models/voregistry/models.py

@@ -0,0 +1,99 @@
+"""Pydantic-xml models for IVOA schema VORegistry 1.1"""
+
+from typing import Optional, Literal
+
+from pydantic_xml import element, attr
+
+import vo_models.vodataservice as vs
+import vo_models.voresource as vr
+from vo_models.voregistry.types import ExtensionSearchSupport, OptionalProtocol
+
+NSMAP = {
+    "vr": "http://www.ivoa.net/xml/VOResource/v1.0",
+    "vg": "http://www.ivoa.net/xml/VORegistry/v1.0",
+    "vs": "http://www.ivoa.net/xml/VODataService/v1.1",
+    "xsi": "http://www.w3.org/2001/XMLSchema-instance",
+    "ri": "http://www.ivoa.net/xml/RegistryInterface/v1.0"
+}
+
+
+class OAIHTTP(vr.Interface, nsmap=NSMAP):
+    """A description of the standard OAI PMH interface using HTTP (GET or POST) queries."""
+
+    type: Literal["vg:OAIHTTP"] = attr(ns="xsi", default="vg:OAIHTTP")
+
+class OAISOAP(vr.WebService, nsmap=NSMAP):
+    """A description of the standard OAI PMH interface using a SOAP Web Service interface."""
+
+    type: Literal["vg:OAISOAP"] = attr(ns="xsi", default="vg:OAISOAP")
+
+class Registry(vr.Service, tag="Resource", nsmap=NSMAP, ns="ri"):
+    """A service that provides access to descriptions of resources.
+
+    Parameters:
+        full:
+            (element) - If true, this registry attempts to collect all resource records known to the IVOA.
+        managed_authority:
+            (element) - An authority identifier managed by the registry.
+        tableset:
+            (element) - For registry interfaces with a user-visible table structure, tableset allows its declaration.
+    """
+
+    full: bool = element(ns="")
+    type: Literal["vg:Registry"] = attr(ns="xsi", default="vg:Registry")
+    managed_authority: Optional[list[vr.AuthorityID]] = element(tag="managedAuthority", default=[], ns="")
+    tableset: Optional[vs.TableSet] = element(tag="tableset", default=None, ns="")
+
+
+class Harvest(vr.Capability, nsmap=NSMAP):
+    """The capabilities of the Registry Harvest implementation.
+
+    Parameters:
+        max_records:
+            (element) - The largest number of records that the registry search method will return.
+        type:
+            (attribute) - The type of the capability, which is always "vg:Harvest".
+        standard_id:
+            (attribute) - The standard ID of the capability, which is always "ivo://ivoa.net/std/Registry".
+    """
+
+    max_records: int = element(tag="maxRecords")
+    type: Literal["vg:Harvest"] = attr(ns="xsi", default="vg:Harvest")
+    standard_id: Literal["ivo://ivoa.net/std/Registry"] = attr(name="standardID", default="ivo://ivoa.net/std/Registry")
+
+
+class Search(vr.Capability, nsmap=NSMAP):
+    """The capabilities of the Registry Search implementation.
+
+    Parameters:
+        max_records:
+            (element) - The largest number of records that the registry search method will return.
+        type:
+            (attribute) - The type of the capability, which is always "vg:Search".
+        standard_id:
+            (attribute) - The standard ID of the capability, which is always "ivo://ivoa.net/std/Registry".
+        extension_search_support:
+            (element) - (deprecated) Used in Registry Interfaces 1.0 to indicate what VOResource extensions a
+            search interface supported.
+        optional_protocol:
+            (element) - (deprecated) Used in Registry Interfaces 1.0 to indicate search protocol extensions.
+    """
+
+    max_records: int = element(tag="maxRecords")
+    type: Literal["vg:Search"] = attr(ns="xsi", default="vg:Search")
+    standard_id: Literal["ivo://ivoa.net/std/Registry"] = attr(name="standardID", default="ivo://ivoa.net/std/Registry")
+    extension_search_support: Optional[ExtensionSearchSupport] = element(tag="extensionSearchSupport", default=None)
+    optional_protocol: Optional[list[OptionalProtocol]] = element(tag="optionalProtocol", default=[])
+
+
+class Authority(vr.Resource, tag="Resource", nsmap=NSMAP, ns="ri"):
+    """A naming authority; an assertion of control over a namespace represented by an authority identifier.
+
+    type:
+        (attribute) - The type of the authority, which is always "vg:Authority".
+    managing_org:
+        (element) - The organization that manages or owns this authority.
+    """
+
+    type: Literal["vg:Authority"] = attr(ns="xsi", default="vg:Authority")
+    managing_org: vr.ResourceName = element(tag="managingOrg", default="")

vo_models-0.4.3.dev0/vo_models/voregistry/types.py

@@ -0,0 +1,20 @@
+"""Simple types for the VO Registry 1.1 specification"""
+
+from enum import Enum
+
+class ExtensionSearchSupport(str, Enum):
+    """Used in Registry Interfaces 1.0 to denote what VOResource extensions a search interface supports."""
+
+    CORE = "core"
+    """Only searches against the core VOResource metadata are supported."""
+    PARTIAL = "partial"
+    """Searches against some VOResource extension metadata are supported, but not necessarily all that exist
+    in the registry."""
+    FULL = "full"
+    """Searches against all VOResource extension metadata  contained in the registry are supported."""
+
+class OptionalProtocol(str, Enum):
+    """Used in Registry Interfaces 1.0 to denote search protocol extensions."""
+
+    XQUERY = "XQuery"
+    """The xquery protocol as defined in VO Registry Interface standard."""

{vo_models-0.4.2.dev0 → vo_models-0.4.3.dev0}/vo_models/voresource/__init__.py

@@ -1,4 +1,4 @@
-"""IVOA VOResource-v1.1.xsd pydantic-xml models"""
+"""IVOA VOResource v1.1 pydantic-xml models"""
 
 from vo_models.voresource.models import (
     AccessURL,

{vo_models-0.4.2.dev0 → vo_models-0.4.3.dev0}/vo_models/voresource/models.py

@@ -1,4 +1,4 @@
-"""Pydantic-xml models for IVOA schema VOResource-v1.1.xsd"""
+"""Pydantic-xml models for IVOA schema VOResource v1.1"""
 import datetime
 from typing import Literal, Optional
 
@@ -18,7 +18,7 @@ NSMAP = {
 }
 
 
-class Validation(BaseXmlModel, nsmap=NSMAP):
+class Validation(BaseXmlModel, ns="", nsmap=NSMAP):
     """A validation stamp combining a validation level and the ID of the validator.
 
     Parameters:
@@ -41,7 +41,7 @@ class Validation(BaseXmlModel, nsmap=NSMAP):
         return values
 
 
-class ResourceName(BaseXmlModel, nsmap=NSMAP):
+class ResourceName(BaseXmlModel, ns="", nsmap=NSMAP):
     """The name of a potentially registered resource.
 
     That is, the entity referred to may have an associated identifier.
@@ -53,11 +53,11 @@ class ResourceName(BaseXmlModel, nsmap=NSMAP):
             (content) - The name of the resource.
     """
 
-    value: str
+    value: Optional[str] = ""
     ivo_id: Optional[IdentifierURI] = attr(name="ivo-id", default=None)
 
 
-class Date(BaseXmlModel, nsmap=NSMAP):
+class Date(BaseXmlModel, ns="", nsmap=NSMAP):
     """A string indicating what the date refers to.
 
     The value of role should be taken from the vocabulary maintained at http://www.ivoa.net/rdf/voresource/date_role.
@@ -75,7 +75,7 @@ class Date(BaseXmlModel, nsmap=NSMAP):
     )
 
 
-class Source(BaseXmlModel, nsmap=NSMAP):
+class Source(BaseXmlModel, ns="", nsmap=NSMAP):
     """A bibliographic reference from which the present resource is derived or extracted.
 
     Parameters:
@@ -90,7 +90,7 @@ class Source(BaseXmlModel, nsmap=NSMAP):
     format: Optional[str] = attr(name="format", default=None)
 
 
-class Rights(BaseXmlModel, nsmap=NSMAP):
+class Rights(BaseXmlModel, ns="", nsmap=NSMAP):
     """A statement of usage conditions.
 
     This will typically include a license, which should be given as a full string
@@ -107,7 +107,7 @@ class Rights(BaseXmlModel, nsmap=NSMAP):
     rights_uri: Optional[networks.AnyUrl] = attr(name="rightsURI", default=None)
 
 
-class AccessURL(BaseXmlModel, nsmap=NSMAP):
+class AccessURL(BaseXmlModel, ns="", nsmap=NSMAP):
     """The URL (or base URL) that a client uses to access the service.
 
     Parameters:
@@ -122,7 +122,7 @@ class AccessURL(BaseXmlModel, nsmap=NSMAP):
     use: Literal["full", "base", "dir"] = attr(name="use")
 
 
-class MirrorURL(BaseXmlModel, nsmap=NSMAP):
+class MirrorURL(BaseXmlModel, ns="", nsmap=NSMAP):
     """A URL of a mirror (i.e., a functionally identical additional service interface) to
 
     Parameters:
@@ -136,7 +136,7 @@ class MirrorURL(BaseXmlModel, nsmap=NSMAP):
     title: Optional[str] = attr(name="title", default=None)
 
 
-class Contact(BaseXmlModel, nsmap=NSMAP):
+class Contact(BaseXmlModel, ns="", nsmap=NSMAP):
     """Information allowing establishing contact, e.g., for purposes of support.
 
     Parameters:
@@ -175,7 +175,7 @@ class Contact(BaseXmlModel, nsmap=NSMAP):
         return values
 
 
-class Creator(BaseXmlModel, nsmap=NSMAP):
+class Creator(BaseXmlModel, ns="", nsmap=NSMAP):
     """The entity (e.g. person or organisation) primarily responsible for creating something
 
     Parameters:
@@ -208,7 +208,7 @@ class Creator(BaseXmlModel, nsmap=NSMAP):
         return values
 
 
-class Relationship(BaseXmlModel, nsmap=NSMAP):
+class Relationship(BaseXmlModel, ns="", nsmap=NSMAP):
     """A description of the relationship between one resource and one or more other resources.
 
     Parameters:
@@ -225,7 +225,7 @@ class Relationship(BaseXmlModel, nsmap=NSMAP):
     related_resource: list[ResourceName] = element(tag="relatedResource")
 
 
-class SecurityMethod(BaseXmlModel, nsmap=NSMAP):
+class SecurityMethod(BaseXmlModel, ns="", nsmap=NSMAP):
     """A description of a security mechanism.
 
     This type only allows one to refer to the mechanism via a URI.  Derived types would allow for more metadata.
@@ -238,7 +238,7 @@ class SecurityMethod(BaseXmlModel, nsmap=NSMAP):
     standard_id: Optional[networks.AnyUrl] = attr(name="standardID", default=None)
 
 
-class Curation(BaseXmlModel, nsmap=NSMAP):
+class Curation(BaseXmlModel, ns="", nsmap=NSMAP):
     """Information regarding the general curation of a resource
 
     Parameters:
@@ -265,7 +265,7 @@ class Curation(BaseXmlModel, nsmap=NSMAP):
     contact: list[Contact] = element(tag="contact")
 
 
-class Content(BaseXmlModel, nsmap=NSMAP):
+class Content(BaseXmlModel, ns="", nsmap=NSMAP):
     """Information regarding the general content of a resource
 
     Parameters:
@@ -299,7 +299,7 @@ class Content(BaseXmlModel, nsmap=NSMAP):
     relationship: Optional[list[Relationship]] = element(tag="relationship", default_factory=list)
 
 
-class Interface(BaseXmlModel, tag="interface", nsmap=NSMAP):
+class Interface(BaseXmlModel, ns="", tag="interface", nsmap=NSMAP):
     """A description of a service interface.
 
     Since this type is abstract, one must use an Interface subclass to describe an actual interface denoting
@@ -334,13 +334,13 @@ class Interface(BaseXmlModel, tag="interface", nsmap=NSMAP):
     test_querystring: Optional[str] = element(tag="testQueryString", default=None)
 
 
-class WebBrowser(Interface, nsmap=NSMAP):
+class WebBrowser(Interface, ns="", nsmap=NSMAP):
     """A (form-based) interface intended to be accesed interactively by a user via a web browser."""
 
     type: Literal["vr:WebBrowser"] = attr(name="type", default="vr:WebBrowser", ns="xsi")
 
 
-class WebService(Interface, nsmap=NSMAP):
+class WebService(Interface, ns="", nsmap=NSMAP):
     """A Web Service that is describable by a WSDL document.
 
     The accessURL element gives the Web Service's endpoint URL.
@@ -355,7 +355,7 @@ class WebService(Interface, nsmap=NSMAP):
     wsdl_url: Optional[list[networks.AnyUrl]] = element(tag="wsdlURL", default_factory=list)
 
 
-class Resource(BaseXmlModel, nsmap=NSMAP):
+class Resource(BaseXmlModel, ns="", nsmap=NSMAP):
     """Any entity or component of a VO application that is describable and
                         identifiable by an IVOA Identifier.
 
@@ -393,10 +393,10 @@ class Resource(BaseXmlModel, nsmap=NSMAP):
     version: Optional[str] = attr(name="version", default=None)
 
     validation_level: Optional[list[Validation]] = element(tag="validationLevel", default_factory=list)
-    title: str = element(tag="title")
-    short_name: Optional[str] = element(tag="shortName", default=None)
-    identifier: networks.AnyUrl = element(tag="identifier")
-    alt_identifier: Optional[list[networks.AnyUrl]] = element(tag="altIdentifier", default_factory=list)
+    title: str = element(tag="title", ns="")
+    short_name: Optional[str] = element(tag="shortName", default=None, ns="")
+    identifier: networks.AnyUrl = element(tag="identifier", ns="")
+    alt_identifier: Optional[list[networks.AnyUrl]] = element(tag="altIdentifier", default_factory=list, ns="")
     curation: Curation = element(tag="curation")
     content: Content = element(tag="content")
 
@@ -415,7 +415,7 @@ class Resource(BaseXmlModel, nsmap=NSMAP):
         return values
 
 
-class Organisation(Resource, nsmap=NSMAP):
+class Organisation(Resource, ns="", nsmap=NSMAP):
     """A named group of one or more persons brought together to pursue participation in VO applications.
 
     Parameters:
@@ -430,7 +430,7 @@ class Organisation(Resource, nsmap=NSMAP):
     instrument: Optional[list[ResourceName]] = element(tag="instrument", default_factory=list)
 
 
-class Capability(BaseXmlModel, tag="capability", nsmap=NSMAP):
+class Capability(BaseXmlModel, ns="", tag="capability", nsmap=NSMAP):
     """A description of what the service does (in terms of context-specific behavior), and how to use it
     (in terms of an interface)
 
@@ -458,7 +458,7 @@ class Capability(BaseXmlModel, tag="capability", nsmap=NSMAP):
     interface: Optional[list[Interface]] = element(tag="interface", default_factory=list)
 
 
-class Service(Resource, nsmap=NSMAP):
+class Service(Resource, ns="", nsmap=NSMAP):
     """A resource that can be invoked by a client to perform some action on its behalf.
 
     Parameters:

{vo_models-0.4.2.dev0 → vo_models-0.4.3.dev0/vo_models.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: vo-models
-Version: 0.4.2.dev0
+Version: 0.4.3.dev0
 Summary: Pydantic data models for IVOA protocols
 Author-email: Joshua Fraustro <jfraustro@stsci.edu>, MAST Archive Developers <archive@stsci.edu>
 Project-URL: Homepage, https://github.com/spacetelescope/vo-models
@@ -28,6 +28,7 @@ Requires-Dist: furo; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
+Dynamic: license-file
 
 # vo-models
 
@@ -61,6 +62,8 @@ The following IVOA protocols are currently supported:
   - others
 - **VOResource version 1.1**
 - **TAPRegExt version 1.0**
+- **VORegistry 1.1**
+- **RegistryInterfaces version 1.0**
 
 You can read more about using these models in our documentation: https://vo-models.readthedocs.io/
 

{vo_models-0.4.2.dev0 → vo_models-0.4.3.dev0}/vo_models.egg-info/SOURCES.txt

@@ -10,6 +10,8 @@ vo_models.egg-info/requires.txt
 vo_models.egg-info/top_level.txt
 vo_models/adql/__init__.py
 vo_models/adql/misc.py
+vo_models/registry_interfaces/__init__.py
+vo_models/registry_interfaces/models.py
 vo_models/stc/__init__.py
 vo_models/stc/models.py
 vo_models/tapregext/__init__.py
@@ -19,6 +21,9 @@ vo_models/uws/models.py
 vo_models/uws/types.py
 vo_models/vodataservice/__init__.py
 vo_models/vodataservice/models.py
+vo_models/voregistry/__init__.py
+vo_models/voregistry/models.py
+vo_models/voregistry/types.py
 vo_models/voresource/__init__.py
 vo_models/voresource/models.py
 vo_models/voresource/types.py