lsst-utils 30.0.0rc2__py3-none-any.whl → 30.0.1rc1__py3-none-any.whl

lsst/utils/deprecated.py

@@ -35,11 +35,11 @@ def deprecate_pybind11(obj: Any, reason: str, version: str, category: type[Warni
 
     Parameters
     ----------
-    obj : function, method, or class
+    obj : `~collections.abc.Callable`
         The function, method, or class to deprecate.
     reason : `str`
         Reason for deprecation, passed to `~deprecated.sphinx.deprecated`.
-    version : 'str'
+    version : `str`
         Next major version in which the interface will be deprecated,
         passed to `~deprecated.sphinx.deprecated`.
     category : `Warning`
@@ -47,7 +47,7 @@ def deprecate_pybind11(obj: Any, reason: str, version: str, category: type[Warni
 
     Returns
     -------
-    obj : function, method, or class
+    obj : `~collections.abc.Callable`
         Wrapped function, method, or class.
 
     Examples
@@ -88,7 +88,7 @@ def suppress_deprecations(category: type[Warning] = FutureWarning) -> Iterator[N
 
     Parameters
     ----------
-    category : `Warning` or subclass
+    category : `Warning`
         The category of warning to suppress.
     """
     with warnings.catch_warnings():

lsst/utils/inheritDoc.py

@@ -28,12 +28,12 @@ def inheritDoc(klass: type) -> Callable:
 
     Parameters
     ----------
-    klass : object
+    klass : `type`
         The class to inherit documentation from.
 
     Returns
     -------
-    decorator : callable
+    decorator : `~collections.abc.Callable`
         Intermediate decorator used in the documentation process.
 
     Notes

lsst/utils/iteration.py

@@ -26,10 +26,10 @@ def chunk_iterable(data: Iterable[Any], chunk_size: int = 1_000) -> Iterator[tup
 
     Parameters
     ----------
-    data : iterable of anything
+    data : `~collections.abc.Iterable` [ `typing.Any` ] of anything
         The iterable to be chunked. Can be a mapping, in which case
         the keys are returned in chunks.
-    chunk_size : int, optional
+    chunk_size : `int`, optional
         The largest chunk to return. Can be smaller and depends on the
         number of elements in the iterator. Defaults to 1_000.
 
@@ -58,7 +58,7 @@ def ensure_iterable(a: Any) -> Iterable[Any]:
 
     Parameters
     ----------
-    a : iterable or `str` or not iterable
+    a : `~collections.abc.Iterable` or `str` or not iterable
         Argument to be converted to an iterable.
 
     Returns
@@ -115,18 +115,19 @@ def _extract_numeric_suffix(s: str) -> tuple[str, int | None]:
     Returns the prefix and the numeric suffix as an integer, if present.
 
     For example:
-    'node1' -> ('node', 1)
-    'node' -> ('node', None)
-    'node123abc' -> ('node123abc', None)
+
+      'node1' -> ('node', 1)
+      'node' -> ('node', None)
+      'node123abc' -> ('node123abc', None)
 
     Parameters
     ----------
-    s : str
+    s : `str`
         The string to extract the numeric suffix from.
 
     Returns
     -------
-    suffix : str
+    suffix : `str`
         The numeric suffix of the string, if any.
     """
     index = len(s)
@@ -151,13 +152,13 @@ def _add_pair_to_name(val_name: list[str], val0: int | str, val1: int | str, str
 
     Parameters
     ----------
-    val_name : List[str]
+    val_name : `list` [ `str` ]
         The list to append the formatted string to.
-    val0 : [int, str]
+    val0 : `int` or `str`
         The starting value of the sequence.
-    val1 : [int, str]
+    val1 : `int` or `str`
         The ending value of the sequence.
-    stride : int, optional
+    stride : `int`, optional
         The stride or difference between consecutive numbers in the
         sequence. Defaults to 1.
     """
@@ -195,12 +196,12 @@ def _is_list_of_ints(values: list[int | str]) -> TypeGuard[list[int]]:
 
     Parameters
     ----------
-    values : List[int, str]:
+    values : `list` [`int` or `str`]:
         The list of values to check.
 
     Returns
     -------
-    is_ints : bool
+    is_ints : `bool`
         True if all values are integers, False otherwise.
     """
     return all(isinstance(v, int) for v in values)
@@ -217,31 +218,33 @@ def sequence_to_string(values: list[int | str]) -> str:
     strings with common prefixes are handled to produce a concise
     representation.
 
-    >>> getNameOfSet([1, 2, 3, 5, 7, 8, 9])
-    '1..3^5^7..9'
-    >>> getNameOfSet(["node1", "node2", "node3"])
-    'node1..node3'
-    >>> getNameOfSet([10, 20, 30, 40])
-    '10..40:10'
-
     Parameters
     ----------
-    values : list[int, str]:
+    values : `list` [ `int` or `str` ]
         A list of items to be compacted. Must all be of the same type.
 
     Returns
     -------
-    sequence_as_string : str
+    sequence_as_string : `str`
         A compact string representation of the input list.
 
     Notes
     -----
-        - The function handles both integers and strings.
-        - For strings with common prefixes, only the differing suffixes are
-            considered.
-        - The stride is determined as the minimum difference between
-            consecutive numbers.
-        - Strings without common prefixes are listed individually.
+    - The function handles both integers and strings.
+    - For strings with common prefixes, only the differing suffixes are
+      considered.
+    - The stride is determined as the minimum difference between
+        consecutive numbers.
+    - Strings without common prefixes are listed individually.
+
+    Examples
+    --------
+    >>> getNameOfSet([1, 2, 3, 5, 7, 8, 9])
+    '1..3^5^7..9'
+    >>> getNameOfSet(["node1", "node2", "node3"])
+    'node1..node3'
+    >>> getNameOfSet([10, 20, 30, 40])
+    '10..40:10'
     """
     if not values:
         return ""

lsst/utils/logging.py

@@ -273,7 +273,7 @@ class LsstLogAdapter(LoggerAdapter):
         *args : `~typing.Any`
             Parameters references by log message.
         **kwargs : `~typing.Any`
-            Parameters forwarded to `log`.
+            Parameters forwarded to underlying logger.
         """
         # There is no other way to achieve this other than a special logger
         # method.
@@ -294,7 +294,7 @@ class LsstLogAdapter(LoggerAdapter):
         *args : `~typing.Any`
             Parameters references by log message.
         **kwargs : `~typing.Any`
-            Parameters forwarded to `log`.
+            Parameters forwarded to underlying logger.
         """
         # There is no other way to achieve this other than a special logger
         # method.

lsst/utils/timer.py

@@ -165,7 +165,7 @@ def logInfo(
         Name prefix, the resulting entries are ``CpuTime``, etc.. For example
         `timeMethod` uses ``prefix = Start`` when the method begins and
         ``prefix = End`` when the method ends.
-    logLevel : optional
+    logLevel : `int`, optional
         Log level (a `logging` level constant, such as `logging.DEBUG`).
     metadata : `collections.abc.MutableMapping`, optional
         Metadata object to write entries to, overriding ``obj.metadata``.
@@ -399,7 +399,7 @@ def time_this(
         Prefix to use to prepend to the supplied logger to
         create a new logger to use instead. No prefix is used if the value
         is set to `None`. Defaults to "timer".
-    args : iterable of any
+    args : `~collections.abc.Iterable` [ `typing.Any` ]
         Additional parameters passed to the log command that should be
         written to ``msg``.
     kwargs : `dict`, optional

lsst/utils/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "30.0.0rc2"
+__version__ = "30.0.1rc1"

lsst/utils/wrappers.py

@@ -186,7 +186,7 @@ class TemplateMeta(type):
     classes with multiple template parameters) are good choices.  Alternate
     type keys for existing classes can be added by calling ``alias``, but only
     after a subclass already been registered with a "primary" type key.  For
-    example::
+    example:
 
     .. code-block:: python
 
@@ -210,7 +210,7 @@ class TemplateMeta(type):
 
     This allows user code to construct objects directly using ``Image``, as
     long as an extra ``dtype`` keyword argument is passed that matches one of
-    the type keys::
+    the type keys:
 
     .. code-block:: python
 
@@ -233,7 +233,7 @@ class TemplateMeta(type):
     As an aid for those writing the Python wrappers for C++ classes,
     ``TemplateMeta`` also provides a way to add pure-Python methods and other
     attributes to the wrapped template classes.  To add a ``sum`` method to
-    all registered types, for example, we can just do::
+    all registered types, for example, we can just do:
 
     .. code-block:: python
 
@@ -259,7 +259,7 @@ class TemplateMeta(type):
 
     Finally, abstract base classes that use ``TemplateMeta`` define a dict-
     like interface for accessing their registered subclasses, providing
-    something like the C++ syntax for templates::
+    something like the C++ syntax for templates:
 
     .. code-block:: python
 

{lsst_utils-30.0.0rc2.dist-info → lsst_utils-30.0.1rc1.dist-info}/METADATA

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: lsst-utils
-Version: 30.0.0rc2
+Version: 30.0.1rc1
 Summary: Utility functions from Rubin Observatory Data Management for the Legacy Survey of Space and Time (LSST).
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://github.com/lsst/utils
+Project-URL: Source, https://github.com/lsst/utils
 Keywords: lsst
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent

{lsst_utils-30.0.0rc2.dist-info → lsst_utils-30.0.1rc1.dist-info}/RECORD

@@ -4,29 +4,29 @@ lsst/utils/_packaging.py,sha256=4laBi-lHsNYHxms9tjyjMVwfmnwAltt-I2HWP-RE3Ds,1422
 lsst/utils/argparsing.py,sha256=ITLsiANA4FEXc_ZKakX_U1beVez6WHdNoMeS8pC2CeY,2963
 lsst/utils/classes.py,sha256=uTs1Coin5TlpH2rwD5RYh3m_JgMBYVnkg2jklb9Djnc,5467
 lsst/utils/db_auth.py,sha256=qREqUDI7jXr49lY3bKhe75mbZsuAPu2zHaAtel30EEY,12924
-lsst/utils/deprecated.py,sha256=vGypsklkL_aAdtovvF0WS4785zZY1jZMZC1aKm6e2EM,3498
+lsst/utils/deprecated.py,sha256=QeSy6PGW1Tv6oMQ4LILOVWcOacugtnDmbbI_hNTe__c,3488
 lsst/utils/doImport.py,sha256=JbD_AR1GQ1PVdK--OJy5tVz1U2Kabe1ETyQoyaq6rpQ,4241
-lsst/utils/inheritDoc.py,sha256=doMsQKcDssZvsTAYJSmHxOWXM4D1wPrDSCTHiaRGUvw,2719
+lsst/utils/inheritDoc.py,sha256=uRTOM01VtjbM0xrDl6kWoSoftl_ip3glRYFE34o39vg,2738
 lsst/utils/introspection.py,sha256=Y1ImDWl5i1O9iRbOoSJhr8Rz57y-_WMgwDtbGJBVxJk,14735
-lsst/utils/iteration.py,sha256=FHDGWcAbWzJdN1RVP-LdtatBfmCW9x_2MdQ5iwmT1sE,9278
-lsst/utils/logging.py,sha256=TPtKK5ShYAEeIFlqhYkEGGSDeUwiMWWzOb1CQGHMBlU,16256
+lsst/utils/iteration.py,sha256=yoxj4OWWDxPjyxw3PB7mjPeEv4f2mD5sBD_tr8ar1-0,9386
+lsst/utils/logging.py,sha256=LkYQ0Wb4-u1wTukAmD2b7wbryvRCV7jKZKey2GYrFrI,16280
 lsst/utils/packages.py,sha256=XGtZCGkxqUCiyHi6LZDakV7tgoxtvABww7Haen84Yj8,27530
 lsst/utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lsst/utils/tests.py,sha256=eEcgGuHfaLorLlPUqwUNbWeO4A_2_r8ON8vTdlhcrek,39185
 lsst/utils/threads.py,sha256=WNl3uvbE7bx5UyxTX0fwN5AkU3Yty_m8y_pMKcMCdv8,2551
-lsst/utils/timer.py,sha256=p_qOEQEIqfQubQJmaN4pK-3YUqZCocY08fBgpnSTXh0,21961
+lsst/utils/timer.py,sha256=-B59CIClWibwgbO_WYLd5QNRC6Te0HbRsiKr3soLCDc,21997
 lsst/utils/usage.py,sha256=qunydx-KlcbNp-vFcBtvBayWwZAa0tHtSWvz5BycvLA,4598
-lsst/utils/version.py,sha256=CrAQNQjb1NNXqaNvScI53U2GvkmrnpRtyOiy0bIrcl4,52
-lsst/utils/wrappers.py,sha256=KCvsrGXziLQ5pC8ytiFEXeDH9mBSo8eCZ8g08f7s404,19209
+lsst/utils/version.py,sha256=-auEgPcWk4qAWrWVMJY7Of7dAJ0dNQHoqQraCNdAEN4,52
+lsst/utils/wrappers.py,sha256=Nj9E961PLhLOG5zq62DMraxmobj4-Sg9ChajGgZ_yUE,19205
 lsst/utils/plotting/__init__.py,sha256=OEAZv2W12UAcUfDxH5H_k8v7cK4fVTOssuqNksZTuIs,507
 lsst/utils/plotting/figures.py,sha256=pLkD7MpYk1Zs2hozA2-6r_uUd1129Uoi9EAEkMvtCjk,4356
 lsst/utils/plotting/limits.py,sha256=6ilPmb4wg4aVtjlBgm75FPBrjDVSkW_ywZrj_QIQD2U,5839
 lsst/utils/plotting/publication_plots.py,sha256=-uOL2ptI3N52KxfhtJNsUt7SqeGdT78GF-_QjHKKmV8,5016
 lsst/utils/plotting/rubin.mplstyle,sha256=mjLPYzolUjeCXq8z4ltXLvEf8IuyT4TS0Nx8JJ05v6I,1063
-lsst_utils-30.0.0rc2.dist-info/licenses/COPYRIGHT,sha256=I6Bxnp_LkIqDjafZNIXM8jfjYWC4XIlpNpZ7jkdeZK0,361
-lsst_utils-30.0.0rc2.dist-info/licenses/LICENSE,sha256=7wrtgl8meQ0_RIuv2TjIKpAnNrl-ODH-QLwyHe9citI,1516
-lsst_utils-30.0.0rc2.dist-info/METADATA,sha256=rSpYEm4OQ-k9b-F4ilwqcRf5wDSobn-DlVCxy0uJG1A,1767
-lsst_utils-30.0.0rc2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-lsst_utils-30.0.0rc2.dist-info/top_level.txt,sha256=eUWiOuVVm9wwTrnAgiJT6tp6HQHXxIhj2QSZ7NYZH80,5
-lsst_utils-30.0.0rc2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-lsst_utils-30.0.0rc2.dist-info/RECORD,,
+lsst_utils-30.0.1rc1.dist-info/licenses/COPYRIGHT,sha256=I6Bxnp_LkIqDjafZNIXM8jfjYWC4XIlpNpZ7jkdeZK0,361
+lsst_utils-30.0.1rc1.dist-info/licenses/LICENSE,sha256=7wrtgl8meQ0_RIuv2TjIKpAnNrl-ODH-QLwyHe9citI,1516
+lsst_utils-30.0.1rc1.dist-info/METADATA,sha256=13P9kg8JfcI1Ftv3BF8lT8rBi5BOfbMDxg4pkyvPfCc,1818
+lsst_utils-30.0.1rc1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+lsst_utils-30.0.1rc1.dist-info/top_level.txt,sha256=eUWiOuVVm9wwTrnAgiJT6tp6HQHXxIhj2QSZ7NYZH80,5
+lsst_utils-30.0.1rc1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+lsst_utils-30.0.1rc1.dist-info/RECORD,,

{lsst_utils-30.0.0rc2.dist-info → lsst_utils-30.0.1rc1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any