microsoftgraph / microsoftgraph/msgraph-sdk-python
False-positive DeprecationWarning
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 630
- Forks
- 96
- Merge moyen
- 15 h 20 min
- PR mergées (30 j)
- 3
Description
Describe the bug
Simply just importing one of the class request builders is enough to trigger a deprecation warnings. The reproduction steps below will output 3 different deprecation warnings, even though the deprecated classes are not being used.
This is because the warnings are in the class scope, so will be ran at "compile" time.
Changing the first example to the second will only warn when the dataclass is instantiated.
# kiota_abstractions.default_query_parameters.py
@dataclass
class GetQueryParameters(QueryParameters):
"""
Default placeholder class for query parameters.
"""
warn("GetQueryParameters is deprecated. Use QueryParameters instead.", DeprecationWarning)
# kiota_abstractions.default_query_parameters.py
@dataclass
class GetQueryParameters(QueryParameters):
"""
Default placeholder class for query parameters.
"""
def __init__(self, *args, **kwargs):
warn("GetQueryParameters is deprecated. Use QueryParameters instead.", DeprecationWarning)
super().__init__(*args, **kwargs)
Expected behavior
Deprecation warnings are only raised when you instantiate a deprecated class I.E. are actually using it, not just importing it.
How to reproduce
python -Wd -c "from msgraph.generated.education.classes.classes_request_builder import ClassesRequestBuilder"
SDK Version
1.12.0
Latest version known to work for scenario above?
No response
Known Workarounds
Only workaround is to suppress deprecation warnings from this library.
import warnings
warnings.filterwarnings("ignore", module="msgraph", category=DeprecationWarning)
warnings.filterwarnings(
"ignore",
module="kiota_abstractions",
category=DeprecationWarning,
)
Debug output
Click to expand log
```</details>
### Configuration
_No response_
### Other information
_No response_
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par kiota_abstractions.default_query_parameters.py et reproduisez l’avertissement à l’aide de la commande d’importation Python fournie. Vérifiez comment les classes request-builder obsolètes émettent des avertissements lors de la définition de la classe, puis vérifiez que l’importation de ClassesRequestBuilder ne produit aucun avertissement, tandis que l’instanciation d’une classe obsolète produit toujours un avertissement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 45/100