Una aplicación GitHub para revisar automáticamente el estilo de código de Python sobre solicitudes de extracción


pycodestyle o flake8 como su linter. El bot puede leer configuraciones para ambos.setup.cfg para secciones [flake8] y [pycodestyle] . Consulte la sección Configuration a continuación. No se requiere un archivo de configuración para que funcione la integración . Sin embargo, se puede configurar adicionalmente agregando un archivo .pep8speaks.yml en la raíz del proyecto. Aquí hay un ejemplo:
# File : .pep8speaks.yml
scanner :
diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
linter : pycodestyle # Other option is flake8
pycodestyle : # Same as scanner.linter value. Other option is flake8
max-line-length : 100 # Default is 79 in PEP 8
ignore : # Errors and warnings to ignore
- W504 # line break after binary operator
- E402 # module level import not at top of file
- E731 # do not assign a lambda expression, use a def
- C406 # Unnecessary list literal - rewrite as a dict literal.
- E741 # ambiguous variable name
no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file
message : # Customize the comment made by the bot
opened : # Messages when a new PR is submitted
header :
" Hello @{name}! Thanks for opening this PR. "
# The keyword {name} is converted into the author's username
footer :
" Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
# The messages can be written as they would over GitHub
updated : # Messages when new commits are added to the PR
header : " Hello @{name}! Thanks for updating this PR. "
footer : " " # Why to comment the link to the style guide everytime? :)
no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "Notas:
.pep8speaks.yml anulará estos valores..pep8speaks.yml en la rama base (la existente). Si no se encuentra el archivo, luego busca en la rama head (los cambios entrantes).scanner.linter en pycodestyle o flake8ignore o max-line-length ), Pep8Speaks se verá y priorizará las configuraciones en el siguiente orden:pycodestyle: o flake8: Sección de .pep8speaks.yml .scanner.linter .[pycodestyle] o [flake8] Sección del archivo setup.cfg en la raíz del proyecto.scanner.linter . Entonces, la sección [flake8] de setup.cfg también funcionará para pycodestyle.| Organización | Descripción | |
|---|---|---|
| Pandas | Herramientas de manipulación de datos potentes para Python | |
| Adobe | Código abierto desde Adobe | |
| usura de apertura | Distribución de Linux | |
| Pytorch Lightning | El liviano envoltura de pytorch para investigadores de ML. | |
| Redx | Biblioteca de Python para teoría de grafos y redes complejas | |
| Estadelo | Modelado estadístico y econometría en Python | |
| xarray (pydata) | Matrices y conjuntos de datos etiquetados en Python (Python para datos) | |
![]() | Soldado | Python para física solar |
| Astropía | Astronomía en Python | |
| Scikit Learn Contrib | Proyectos compatibles con Scikit-Learn | |
| Imagen de Scikit | Procesamiento de imágenes en Python | |
| IDE SPYDER | El entorno de desarrollo científico de Python | |
![]() | Catalizador | Marco de Pytorch para la investigación y el desarrollo del aprendizaje profundo |
Consulte la lista completa de organizaciones y usuarios.
@pep8speaks suggest diff en un comentario del PR, y comentará una esencia de diff sugerir soluciones para el PR. Ejemplo@pep8speaks pep8ify en el PR y creará una solicitud de extracción con los cambios sugeridos por autopep8 contra la rama del autor del PR. autopep8 corrige la mayoría de los errores reportados por pycodestyle .[skip pep8] en cualquier lugar del mensaje de confirmación, título de relaciones públicas o descripción de relaciones públicas para prohibir que Pep8speaks comente sobre la solicitud de extracción.Esta aplicación solo funcionará para repositorios alojados públicamente. Entonces, si está buscando implementar una bifurcación o usar la aplicación para repositorios privados , aquí están las instrucciones.
pep8 ). Las actualizaciones de la aplicación se anuncian utilizando la función de lanzamiento de GitHub aquí. Se realizan muchos cambios importantes a medida que la comunidad se hace más grande. Haga clic en Watch -> Releases only en la parte superior de la página, para recibir una notificación sobre nuevas configuraciones o actualizaciones de características.
Por lo general, la rama maestra se implementa tan pronto como las solicitudes de extracción se fusionan en el repositorio. Sin embargo, todos los viernes, hago un lanzamiento y me aseguro de que el último código esté implementado. No necesita hacer nada para usar la última versión. Si usa una bifurcación de Pep 8 Speaks, consulte el espacio de lanzamiento.
Conviértase en un patrocinador de oro y obtenga su logotipo y nombre con un enlace a su sitio en nuestro ReadMe y nuestro sitio web.
Gobernanza de samagra | ![]() Samagrax |
Conviértase en un patrocinador de oro y obtenga su logotipo y nombre con un enlace a su sitio en nuestro ReadMe y nuestro sitio web.
Python Software Foundation | Cronometrar |
Conviértase en un patrocinador plateado y obtenga su logotipo y nombre con un enlace a su sitio en nuestro ReadMe y nuestro sitio web.
Ccextractor | Sudhanshu Mishra |
Puede apoyar el proyecto contribuyendo a su desarrollo. Si tiene alguna sugerencia para nuevas funciones o mejoras, cree un problema. ¡Las solicitudes de extracción son bienvenidas! Lea el documento contribuyente para comprender cómo funciona el proyecto y cómo puede hacer cambios.
El proyecto requiere ser alojado en un servidor y, debido a que también necesita soporte financiero.
Lea el caso para financiar PEP 8 Speaks.
Si usa este proyecto y le gusta, hágamelo saber. ¡Gracias!
❤️
Este proyecto no respalda todas las reglas del PEP 8 original y, por lo tanto, cree en la personalización de Pycodestyle.
.