New sphinx docs fix (#2852)

* Fix typo, ConjunctionGraph -> ConjunctiveGraph, the new version of Sphinx-autodocs flagged this as an error. * more autodoc fixes for new sphinx version * Fix sphinx autodocs complaining while probing attributes on DefinedNamespace classes. Add correct annotation details for items that sphinx cannot find. --------- Co-authored-by: Nicholas Car <nick@kurrawong.net>

Author: ashleysommer

poetry.lock

@@ -60,10 +60,10 @@ setuptools = ">=68,<72"
 wheel = ">=0.42,<0.44"
 
 [tool.poetry.group.docs.dependencies]
-sphinx = "^7.1.1"
+sphinx = ">=7.1.2,<8"
 myst-parser = ">=2,<4"
 sphinxcontrib-apidoc = ">=0.3,<0.6"
-sphinx-autodoc-typehints = "^1.17.1"
+sphinx-autodoc-typehints = ">=1.25.3,<=2.0.1"
 typing-extensions = "^4.5.0"
 
 [tool.poetry.group.lint.dependencies]

pyproject.toml

@@ -433,6 +433,11 @@ class Graph(Node):
  For more on named graphs, see: http://www.w3.org/2004/03/trix/
  """
 
+ context_aware: bool
+ formula_aware: bool
+ default_union: bool
+ base: Optional[str]
+
  def __init__(
  self,
  store: Union[Store, str] = "default",
@@ -1393,9 +1398,9 @@ def parse(
  :doc:`Security Considerations </security_considerations>`
  documentation.
 
- :param source: An `InputSource`, file-like object, `Path` like object,
- or string. In the case of a string the string is the location of the
- source.
+ :param source: An `xml.sax.xmlreader.InputSource`, file-like object,
+ `pathlib.Path` like object, or string. In the case of a string the string
+ is the location of the source.
  :param location: A string indicating the relative or absolute URL of the
  source. `Graph`'s absolutize method is used if a relative location
  is specified.
@@ -1910,6 +1915,8 @@ class ConjunctiveGraph(Graph):
  All queries are carried out against the union of all graphs.
  """
 
+ default_context: _ContextType
+
  def __init__(
  self,
  store: Union[Store, str] = "default",
@@ -2227,8 +2234,9 @@ def parse(
 
  See :meth:`rdflib.graph.Graph.parse` for documentation on arguments.
 
- If the source is in a format that does not support named graphs it's triples
- will be added to the default graph (i.e. `Dataset.default_context`).
+ If the source is in a format that does not support named graphs its triples
+ will be added to the default graph
+ (i.e. :attr:`ConjunctiveGraph.default_context`).
 
  :Returns:
 
@@ -2254,7 +2262,7 @@ def parse(
  the ``publicID`` parameter will also not be used as the name for the
  graph that the data is loaded into, and instead the triples from sources
  that do not support named graphs will be loaded into the default graph
- (i.e. `ConjunctiveGraph.default_context`).
+ (i.e. :attr:`ConjunctiveGraph.default_context`).
  """
 
  source = create_input_source(
@@ -2488,8 +2496,9 @@ def parse(
 
  The source is specified using one of source, location, file or data.
 
- If the source is in a format that does not support named graphs it's triples
- will be added to the default graph (i.e. `Dataset.default_context`).
+ If the source is in a format that does not support named graphs its triples
+ will be added to the default graph
+ (i.e. :attr:`.Dataset.default_context`).
 
  .. caution::
 
@@ -2510,7 +2519,7 @@ def parse(
  the ``publicID`` parameter will also not be used as the name for the
  graph that the data is loaded into, and instead the triples from sources
  that do not support named graphs will be loaded into the default graph
- (i.e. `ConjunctiveGraph.default_context`).
+ (i.e. :attr:`.Dataset.default_context`).
  """
 
  c = ConjunctiveGraph.parse(

rdflib/graph.py

@@ -7,7 +7,7 @@ class WGS(DefinedNamespace):
  Basic Geo (WGS84 lat/long) Vocabulary
 
  The HTML Specification for the vocabulary can be found
- `here <https://www.w3.org/2003/01/geo/>`.
+ here <https://www.w3.org/2003/01/geo/>.
  """
 
  _NS = Namespace("https://www.w3.org/2003/01/geo/wgs84_pos#")

rdflib/namespace/_WGS.py

@@ -233,6 +233,13 @@ def __repr__(self) -> str:
  "_underscore_num",
 }
 
+# Some libraries probe classes for certain attributes or items.
+# This is a list of those attributes and items that should be ignored.
+_IGNORED_ATTR_LOOKUP: Set[str] = {
+ "_pytestfixturefunction", # pytest tries to look this up on Defined namespaces
+ "_partialmethod", # sphinx tries to look this up during autodoc generation
+}
+
 
 class DefinedNamespaceMeta(type):
  """Utility metaclass for generating URIRefs with a common prefix."""
@@ -246,10 +253,13 @@ class DefinedNamespaceMeta(type):
  @lru_cache(maxsize=None)
  def __getitem__(cls, name: str, default=None) -> URIRef:
  name = str(name)
+
  if name in _DFNS_RESERVED_ATTRS:
  raise AttributeError(
  f"DefinedNamespace like object has no attribute {name!r}"
  )
+ elif name in _IGNORED_ATTR_LOOKUP:
+ raise KeyError()
  if str(name).startswith("__"):
  # NOTE on type ignore: This seems to be a real bug, super() does not
  # implement this method, it will fail if it is ever reached.
@@ -265,6 +275,8 @@ def __getitem__(cls, name: str, default=None) -> URIRef:
  return cls._NS[name]
 
  def __getattr__(cls, name: str):
+ if name in _IGNORED_ATTR_LOOKUP:
+ raise AttributeError()
  return cls.__getitem__(name)
 
  def __repr__(cls) -> str: