python / python/devguide

Document the various code generation tools used by CPython

Ouverte
#805 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

topic-dev process type-feature
Langage dominant
Python
Étoiles
2.1k
Forks
1k
Merge moyen
2 j 12 h
PR mergées (30 j)
12

Description

Describe the enhancement or feature you'd like

There should be some documentation about the various code generation tools used in CPython, for example:

  • freeze_modules.py
  • deepfreeze.py
  • generate_global_objects.py

I don't think there needs to be a massive amount of documentation about these. Just a brief mention of their purposes, how to invoke them, and notes about their related make targets.

Related are the Parser generator etc., which are already documented under Guide to CPython's Parser, but could also be mentioned. I think their existing docs could also be used as something of a template.

Describe alternatives you've considered

Argument clinic is already documented at https://docs.python.org/3/howto/clinic.html so maybe this documentation would be more appropriate in the main Python repo's docs? I'll defer to the devguide maintainers on this.

Additional context

Started from a conversation at https://github.com/python/cpython/pull/30941#issuecomment-1023501086

CC @ericisnowcurrently

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez la section existante « Guide to CPython's Parser » et les outils listés : freeze_modules.py, deepfreeze.py et generate_global_objects.py. Déterminez si la documentation doit figurer dans le devguide ou dans la documentation de CPython, puis documentez l’objectif, l’appel et les make targets associés de chaque outil, avec des liens vers les générateurs de parsers lorsque cela est pertinent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
build-system, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.