ansys / ansys/pymechanical

Deprecate logging.Configuration, rename to logging.LoggingConfiguration

Open
#324 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
83
Forks
37
Avg merge
1d 3m
Merged PRs (30d)
26

Description

Breaking change... server side you mean? If it's client side, I would deprecate the old class and do the following

https://stackoverflow.com/a/9008509

```py
def OldClsName(*args, **kwargs):
from warnings import warn
warn("Deprecated class. Use ``NewClsName``. Support will be removed in next minor version.")
return NewClsName(*args, **kwargs)
```

In whatever version you want, you remove support for it. Leave some time for end users to adapt in the meantime. The "old class" will no longer be a class but a function with the previous approach. But this should work.

_Originally posted by @RobPasMue in https://github.com/ansys/pymechanical/pull/308#discussion_r1284501871_

Contributor guide

Open the contributing guide

Research direction

The issue names logging.Configuration and the proposed logging.LoggingConfiguration, but no files, tests, or entry points. Start by locating references to the old class and review the linked pull-request discussion, including whether the change is server-side or client-side. Done means the renamed API works and the old name follows the agreed deprecation and removal approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.