Skip to content

Commit

Permalink
Update copyright notice
Browse files Browse the repository at this point in the history
  • Loading branch information
nineteendo committed Feb 5, 2025
1 parent c6e652d commit 41d6573
Show file tree
Hide file tree
Showing 27 changed files with 15 additions and 26 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,8 @@ applications:
| Complex object | 9.21 | 8.66 | 8.91 | 7.95 | 1.00 | 130.93 |
| Dict with 256 lists of 256 dicts with 1 int | 18.00 | 22.32 | 12.38 | 10.84 | 1.00 | 1622.21 |

> [!WARNING]
> The Python version of jsonyx is up to 36.25x slower, so double check that the
> C version is installed.

[^1]: failed due to recursion error
1 change: 0 additions & 1 deletion bench/__main__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON benchmark."""
from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Command Line Interface
======================

.. meta::
:canonical: .
:canonical: .

.. versionadded:: 2.0

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Copyright (C) 2024 Nice Zombies
"""Configuration file for the Sphinx documentation builder."""
from __future__ import annotations

from datetime import UTC, datetime
from os import environ, getenv
from typing import Any

Expand All @@ -10,7 +10,7 @@
branch: str = getenv("READTHEDOCS_GIT_IDENTIFIER", "main")
project: str = "jsonyx"
# pylint: disable-next=W0622
copyright: str = "2024, Nice Zombies" # noqa: A001
copyright: str = f"{datetime.now(tz=UTC).year}, Nice Zombies" # noqa: A001
author: str = "Nice Zombies"

release: str = "2.0"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ Pretty printing
}

.. tip:: Use ``ensure_ascii=True`` to escape non-ASCII characters,
``max_indent_level=1`` to indent up to level 1, and ``sort_keys=True``
to sort the keys of objects.
``max_indent_level=1`` to indent up to level 1, and ``sort_keys=True`` to
sort the keys of objects.

.. seealso:: The built-in :mod:`pprint` module for pretty-printing arbitrary
Python data structures.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/how-to.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Example with :mod:`numpy`:
[false, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0.0, 0.0, 0.0, 0.0]

.. note:: Custom types must be registered manually, :mod:`jsonyx` does not
infer serializability based on method presence.
infer serializability based on method presence.
.. warning:: Avoid specifying ABCs for ``types``, that is very slow.

.. _using_hooks:
Expand Down
3 changes: 3 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ Complex object 9.21 8.66 8.91 7.95 1.00
Dict with 256 lists of 256 dicts with 1 int 18.00 22.32 12.38 10.84 1.00 1622.21
=========================================== ===== ====== ======= ====== ======== =========

.. warning:: The Python version of jsonyx is up to 36.25x slower, so double
check that the C version is installed.

Check out the :doc:`get-started` section for further information, including how
to :ref:`install <installation>` the project.

Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ line-length = 79
ignore = [
"ANN401", # any-type
"C901", # complex-structure
"CPY001", # missing-copyright-notice
"DOC201", # docstring-missing-returns
"DOC501", # docstring-missing-exception
"I001", # unsorted-imports
"INP001", # implicit-namespace-package
"PGH003", # blanket-type-ignore
"PLR0912", # too-many-branches
"PLR0913", # too-many-arguments
Expand Down
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""jsonyx extension modules."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""Customizable JSON library for Python."""
# TODO(Nice Zombies): update badge branch
from __future__ import annotations
Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/__main__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/usr/bin/env python
# Copyright (C) 2024 Nice Zombies
"""A command line utility to manipulate JSON files."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/_decoder.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON decoder."""
# TODO(Nice Zombies): Fix end_offset in JSONSyntaxError
from __future__ import annotations
Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/_differ.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON differ."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/_encoder.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON encoder."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/_manipulator.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON manipulator."""
# TODO(Nice Zombies): add error messages
# TODO(Nice Zombies): update schema ID
Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/allow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""Allow JSON deviations not requiring human intervention."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON test utils."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_dump.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON dump tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_dumps.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON dumps tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_jsonyx.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
# TODO(Nice Zombies): test apply_patch
# TODO(Nice Zombies): test schema
"""JSON tests."""
Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_load_query_value.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON load_query_value tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_loads.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON loads tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_make_patch.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON make_patch tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_run_filter_query.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON run_filter_query tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_run_select_query.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON run_select_query tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_syntax_error.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSONSyntaxError tests."""
from __future__ import annotations

Expand Down
1 change: 0 additions & 1 deletion src/jsonyx/test/test_write.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Copyright (C) 2024 Nice Zombies
"""JSON write tests."""
from __future__ import annotations

Expand Down

0 comments on commit 41d6573

Please sign in to comment.