Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 1, 2024

Bumps the required group with 12 updates in the / directory:

Package From To
pydoclint 0.5.6 0.5.9
black 24.8.0 24.10.0
mkdocs-macros-plugin 1.0.5 1.3.7
mkdocs-material 9.5.34 9.5.43
mkdocstrings[python] 0.25.2 0.26.2
mkdocstrings-python 1.10.9 1.12.2
mypy 1.11.2 1.13.0
types-protobuf 5.27.0.20240626 5.28.3.20241030
nox 2024.4.15 2024.10.9
pylint 3.2.7 3.3.1
pytest 8.3.2 8.3.3
hypothesis 6.111.2 6.116.0

Updates pydoclint from 0.5.6 to 0.5.9

Updates black from 24.8.0 to 24.10.0

Updates mkdocs-macros-plugin from 1.0.5 to 1.3.7

Updates mkdocs-material from 9.5.34 to 9.5.43

Updates mkdocstrings[python] from 0.25.2 to 0.26.2

Updates mkdocstrings-python from 1.10.9 to 1.12.2

Updates mypy from 1.11.2 to 1.13.0

Updates types-protobuf from 5.27.0.20240626 to 5.28.3.20241030

Updates nox from 2024.4.15 to 2024.10.9

Updates pylint from 3.2.7 to 3.3.1

Updates pytest from 8.3.2 to 8.3.3

Updates hypothesis from 6.111.2 to 6.116.0

@dependabot dependabot bot requested a review from a team as a code owner November 1, 2024 18:08
@dependabot dependabot bot added part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users labels Nov 1, 2024
@dependabot dependabot bot requested review from Marenz and removed request for a team November 1, 2024 18:08
@llucax llucax self-assigned this Nov 4, 2024
@llucax
Copy link
Contributor

llucax commented Nov 4, 2024

I'm fixing the new issues.

@github-actions github-actions bot added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:data-pipeline Affects the data pipeline part:actor Affects an actor ot the actors utilities (decorator, etc.) part:core Affects the SDK core components (data structures, etc.) part:microgrid Affects the interactions with the microgrid labels Nov 4, 2024
@llucax llucax added scope:breaking-change Breaking change, users will need to update their code and removed part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:data-pipeline Affects the data pipeline part:actor Affects an actor ot the actors utilities (decorator, etc.) part:core Affects the SDK core components (data structures, etc.) part:microgrid Affects the interactions with the microgrid labels Nov 4, 2024
@llucax llucax added this to the v1.0.0-rc1100 milestone Nov 4, 2024
@llucax
Copy link
Contributor

llucax commented Nov 4, 2024

Updated. One breaking change, now the MovingWindow take all constructor arguments as keyword-only.

@llucax llucax enabled auto-merge November 4, 2024 18:25
from collections.abc import Sequence
from datetime import datetime, timedelta
from typing import SupportsIndex, overload
from typing import SupportsIndex, assert_never, overload
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assert never doesn't seem to be used? at least not in the commit where it is added

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Contributor

@Marenz Marenz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, one comment

@llucax llucax added this pull request to the merge queue Nov 5, 2024
@Marenz Marenz removed this pull request from the merge queue due to a manual request Nov 5, 2024
@Marenz
Copy link
Contributor

Marenz commented Nov 5, 2024

Removed from queue in case you wanna change that import

dependabot bot and others added 2 commits November 5, 2024 09:24
Bumps the required group with 12 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [pydoclint](https://github.com/jsh9/pydoclint) | `0.5.6` | `0.5.9` |
| [black](https://github.com/psf/black) | `24.8.0` | `24.10.0` |
| [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin) | `1.0.5` | `1.3.7` |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.34` | `9.5.43` |
| [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.25.2` | `0.26.2` |
| [mkdocstrings-python](https://github.com/mkdocstrings/python) | `1.10.9` | `1.12.2` |
| [mypy](https://github.com/python/mypy) | `1.11.2` | `1.13.0` |
| [types-protobuf](https://github.com/python/typeshed) | `5.27.0.20240626` | `5.28.3.20241030` |
| [nox](https://github.com/wntrblm/nox) | `2024.4.15` | `2024.10.9` |
| [pylint](https://github.com/pylint-dev/pylint) | `3.2.7` | `3.3.1` |
| [pytest](https://github.com/pytest-dev/pytest) | `8.3.2` | `8.3.3` |
| [hypothesis](https://github.com/HypothesisWorks/hypothesis) | `6.111.2` | `6.116.0` |

Updates `pydoclint` from 0.5.6 to 0.5.9
- [Release notes](https://github.com/jsh9/pydoclint/releases)
- [Changelog](https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md)
- [Commits](jsh9/pydoclint@0.5.6...0.5.9)

Updates `black` from 24.8.0 to 24.10.0
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@24.8.0...24.10.0)

Updates `mkdocs-macros-plugin` from 1.0.5 to 1.3.7
- [Release notes](https://github.com/fralau/mkdocs_macros_plugin/releases)
- [Changelog](https://github.com/fralau/mkdocs-macros-plugin/blob/master/CHANGELOG.md)
- [Commits](fralau/mkdocs-macros-plugin@v1.0.5...v1.3.7)

Updates `mkdocs-material` from 9.5.34 to 9.5.43
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.34...9.5.43)

Updates `mkdocstrings[python]` from 0.25.2 to 0.26.2
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.25.2...0.26.2)

Updates `mkdocstrings-python` from 1.10.9 to 1.12.2
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.10.9...1.12.2)

Updates `mypy` from 1.11.2 to 1.13.0
- [Changelog](https://github.com/python/mypy/blob/master/CHANGELOG.md)
- [Commits](python/mypy@v1.11.2...v1.13.0)

Updates `types-protobuf` from 5.27.0.20240626 to 5.28.3.20241030
- [Commits](https://github.com/python/typeshed/commits)

Updates `nox` from 2024.4.15 to 2024.10.9
- [Release notes](https://github.com/wntrblm/nox/releases)
- [Changelog](https://github.com/wntrblm/nox/blob/main/CHANGELOG.md)
- [Commits](wntrblm/nox@2024.04.15...2024.10.09)

Updates `pylint` from 3.2.7 to 3.3.1
- [Release notes](https://github.com/pylint-dev/pylint/releases)
- [Commits](pylint-dev/pylint@v3.2.7...v3.3.1)

Updates `pytest` from 8.3.2 to 8.3.3
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](pytest-dev/pytest@8.3.2...8.3.3)

Updates `hypothesis` from 6.111.2 to 6.116.0
- [Release notes](https://github.com/HypothesisWorks/hypothesis/releases)
- [Commits](HypothesisWorks/hypothesis@hypothesis-python-6.111.2...hypothesis-python-6.116.0)

---
updated-dependencies:
- dependency-name: pydoclint
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: black
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocs-macros-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: mkdocstrings[python]
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mypy
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: types-protobuf
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: nox
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: pylint
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: pytest
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: hypothesis
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
...

Signed-off-by: dependabot[bot] <[email protected]>
The `MovingWindow` constructor now takes all arguments as keyword-only
to avoid mistakes, such as confusing the `size` with the
`input_sampling_period`.

Signed-off-by: Leandro Lucarella <[email protected]>
This check verifies that the `Raises` section of a method docstring
contains the same exception types present in `raise` statements in the
code.

Some checks were correctly failing because of wrong documentation or
typos, but some fail only because `pydoclint` is not smart enough to
figure out the type of variables, so one must always have `raise
ExceptionType` in the code to make the check pass. It also fails when
the exception is raised indirectly, but we want to document it anyways,
for example if raised by some utility function or private method.

For cases where this is possible, the code was changed to do explicit
`raise ExceptionType`, for other cases the check is simply disabled. In
other cases a `raise` was replaced with an `assert_never` to make the
check pass and also make sure a failure is detected by `mypy` instead of
at runtime.

Signed-off-by: Leandro Lucarella <[email protected]>
When appropriate, we just make arguments keyword-only, which is a good
practice anyway. For tests, in general we just disabled the check.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax force-pushed the dependabot/pip/required-de08fd04c0 branch from 19df292 to 483b4ce Compare November 5, 2024 08:25
@github-actions github-actions bot added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:data-pipeline Affects the data pipeline part:actor Affects an actor ot the actors utilities (decorator, etc.) part:core Affects the SDK core components (data structures, etc.) part:microgrid Affects the interactions with the microgrid labels Nov 5, 2024
@llucax
Copy link
Contributor

llucax commented Nov 5, 2024

Updated to move the assert_never import to the correct commit.

@llucax llucax requested a review from Marenz November 5, 2024 08:26
@llucax llucax enabled auto-merge November 5, 2024 08:26
@llucax llucax added this pull request to the merge queue Nov 5, 2024
Merged via the queue into v1.x.x with commit 1986665 Nov 5, 2024
20 checks passed
@llucax llucax deleted the dependabot/pip/required-de08fd04c0 branch November 5, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:actor Affects an actor ot the actors utilities (decorator, etc.) part:core Affects the SDK core components (data structures, etc.) part:data-pipeline Affects the data pipeline part:docs Affects the documentation part:microgrid Affects the interactions with the microgrid part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) scope:breaking-change Breaking change, users will need to update their code type:tech-debt Improves the project without visible changes for users

Projects

Development

Successfully merging this pull request may close these issues.

3 participants