pydocstyle - Online en la nube

PROGRAMA:

NOMBRE

pydocstyle - Documentación de pydocstyle

(anteriormente pep257)

estilopydoc es una herramienta de análisis estático para verificar el cumplimiento de la cadena de documentos de Python
convenciones

estilopydoc soporta la mayoría de PEP 257 fuera de la caja, pero no debe considerarse un
Implementación de referencia.

1. Instalar

pip instalar pydocstyle

2. corrida

$ pydocstyle prueba.py
test.py:18 en la clase privada anidada `meta`:
D101: falta la cadena de documentos
test.py:22 en el método público `método`:
D102: falta la cadena de documentos
...

3. Corrija su código :)

Contenido:

USO

Instalación
Usa pepita o easy_install:

pip instalar pydocstyle

Alternativamente, puede utilizar pydocstyle.py archivo fuente directamente - es autónomo.

Comando Line Fácil de usar
Uso
Uso: pydocstyle [opciones] [ ...]

Opciones:
--version muestra el número de versión del programa y sale
-h, --help mostrar este mensaje de ayuda y salir
-e, --explica mostrar explicación de cada error
-s, --source muestra la fuente de cada error
-d, --debug imprimir información de depuración
-v, - información sobre el estado de la impresión en alto
--count imprime el número total de errores a la salida estándar
--select = elija la lista básica de errores comprobados especificando
qué errores comprobar (con una lista de comas
códigos de error separados). por ejemplo:
--seleccionar = D101, D202
--ignore = elija la lista básica de errores comprobados especificando
qué errores ignorar (con una lista de
códigos de error). por ejemplo: --ignore = D101, D202
--convention = elija la lista básica de errores comprobados especificando
una convención existente. Posibles convenciones: pep257
--add-select = modificar la lista de errores para comprobar especificando
más códigos de error para comprobar.
--add-ignore = modificar la lista de errores para comprobar especificando
más códigos de error para ignorar.
--match = marque solo los archivos que coincidan exactamente regular
expresión; por defecto es --match = '(?! test _). * \. py' que
coincide con archivos que no comienzan con 'test_' pero terminan
con '.py'
--match-dir =
buscar solo directorios que coincidan exactamente regular
expresión; el predeterminado es --match-dir = '[^ \.]. *', que
coincide con todos los directorios que no comienzan con un punto

Ida y vuelta Código
┌──┬─────────────────────────────────┐
│0 │ Éxito, sin infracciones │
├──┼─────────────────────────────────┤
│1 │ Se encontraron algunas violaciones al código │
├──┼─────────────────────────────────┤
│2 │ Uso ilegal - ver error │
│ │ mensaje │
└──┴─────────────────────────────────┘

Configuration archivos
estilopydoc apoya ini-como archivos de configuración. Para poder estilopydoc para usarlo
debe ser nombrada una de las siguientes opciones, y tener un [estilo pydoc] .

· configuración.cfg

· tox.ini

· .pydocestilo

· .pydocstylerc

Al buscar un archivo de configuración, estilopydoc busca uno de los archivos especificados
above in que exacto solicite. Si no se encuentra un archivo de configuración, sigue buscando uno
subir por el árbol de directorios hasta encontrar uno o utilizar la configuración predeterminada.

NOTA:
Para fines de compatibilidad con versiones anteriores, estilopydoc admite archivos de configuración llamados
.pep257, así como el encabezado de la sección [pep257]. Sin embargo, estos se consideran obsoletos.
y el soporte se eliminará en la próxima versión principal.

Disponibles De Seguros
No todas las opciones de configuración están disponibles en los archivos de configuración. Opciones Disponibles
son:

· convención

· selecciona

· pasar por alto

· agregar_seleccionar

· agregar_ignorar

· partido

· coincidencia_dir

Consulte las Uso sección para más información.

Herencia
De forma predeterminada, al encontrar un archivo de configuración, estilopydoc intenta heredar al padre
configuración del directorio y fusionarlos con los locales.

El proceso de fusión es el siguiente:

· Si uno de selecciona, pasar por alto or convención se especificó en la configuración secundaria -
Ignora la configuración principal y establece los nuevos códigos de error para verificar. De lo contrario, simplemente
copia los códigos de error comprobados por los padres.

· Si agregar-ignorar or agregar-seleccionar se especificaron, agrega o elimina los códigos de error especificados
de la lista de códigos de error comprobados.

· Si partido or partido-dir fueron especificados - úselos. De lo contrario, use el de los padres.

Para deshabilitar esto (útil para archivos de configuración ubicados en la raíz de su repositorio),
simplemente agrega heredar = falso a su archivo de configuración.

NOTA:
Si alguno de selecciona, pasar por alto or convención se especificaron en la CLI, la configuración
los archivos no participarán en la elección de los códigos de error que se comprobarán. partido y
partido-dir seguirá teniendo efecto.

Ejemplo
[estilo pydoc]
heredar = falso
ignorar = D100, D203, D405
coincidencia = * .py

ERROR Codigos

Agrupamiento
┌────────────────────────┬─────────────────────── ───────────┐
│Desaparecido cadenas de documentación │ │
├────────────────────────┼──────────────────────── ───────────┤
│D100 │ Falta una cadena de documentos en público │
│ │ módulo │
├────────────────────────┼──────────────────────── ───────────┤
│D101 │ Falta una cadena de documentos en público │
│ │ clase │
├────────────────────────┼──────────────────────── ───────────┤
│D102 │ Falta una cadena de documentos en público │
│ │ método │
├────────────────────────┼──────────────────────── ───────────┤
│D103 │ Falta una cadena de documentos en público │
│ │ función │
├────────────────────────┼──────────────────────── ───────────┤
│D104 │ Falta una cadena de documentos en público │
│ │ paquete │
├────────────────────────┼──────────────────────── ───────────┤
│D105 │ Falta una cadena de documentos en magia │
│ │ método │
├────────────────────────┼──────────────────────── ───────────┤
│Espacio en blanco Temas │ │
├────────────────────────┼──────────────────────── ───────────┤
│D200 │ La cadena de documentos de una línea debe caber en │
│ │ una línea con comillas │
├────────────────────────┼──────────────────────── ───────────┤
│D201 │ No se permiten líneas en blanco antes de │
│ │ función docstring │
├────────────────────────┼──────────────────────── ───────────┤
│D202 │ No se permiten líneas en blanco después de │
│ │ función docstring │
├────────────────────────┼──────────────────────── ───────────┤
│D203 │ Se requiere 1 línea en blanco antes de │
│ │ clase docstring │
├────────────────────────┼──────────────────────── ───────────┤
│D204 │ Se requiere 1 línea en blanco después de │
│ │ clase docstring │
├────────────────────────┼──────────────────────── ───────────┤
│D205 │ Se requiere 1 línea en blanco entre │
│ │ línea de resumen y descripción │
└────────────────────────┴──────────────────────── ───────────┘

│D206 │ Docstring debe tener sangría │
│ │ con espacios, no tabulaciones │
├────────────────────────┼──────────────────────── ───────────┤
│D207 │ Docstring no tiene sangría │
├────────────────────────┼──────────────────────── ───────────┤
│D208 │ Docstring tiene demasiada sangría │
├────────────────────────┼──────────────────────── ───────────┤
│D209 │ Cierre de cadena de documentos multilínea │
│ │ las citas deben estar separadas │
│ │ línea │
├────────────────────────┼──────────────────────── ───────────┤
│D210 │ No se permiten espacios en blanco │
│ │ texto de la cadena de documentos circundante │
├────────────────────────┼──────────────────────── ───────────┤
│D211 │ No se permiten líneas en blanco antes de │
│ │ clase docstring │
├────────────────────────┼──────────────────────── ───────────┤
│Citas Temas │ │
├────────────────────────┼──────────────────────── ───────────┤
│D300 │ Utilice "" "comillas dobles triples" "" │
├────────────────────────┼──────────────────────── ───────────┤
│D301 │ Use r "" "si hay alguna barra invertida en un │
│ │ cadena de documentación │
├────────────────────────┼──────────────────────── ───────────┤
│D302 │ Utilice u "" "para cadenas de documentos Unicode │
├────────────────────────┼──────────────────────── ───────────┤
│cadena de documentación Contenido Temas │ │
├────────────────────────┼──────────────────────── ───────────┤
│D400 │ La primera línea debe terminar con │
│ │ período │
├────────────────────────┼──────────────────────── ───────────┤
│D401 │ La primera línea debe estar en │
│ │ estado de ánimo imperativo │
├────────────────────────┼──────────────────────── ───────────┤
│D402 │ La primera línea no debe ser la │
│ │ "firma" de la función │
├────────────────────────┼──────────────────────── ───────────┤
│D403 │ Primera palabra de la primera línea │
│ │ debe estar correctamente en mayúscula │
└────────────────────────┴──────────────────────── ───────────┘

Predeterminado Cheques
No todos los códigos de error están marcados de forma predeterminada. El comportamiento predeterminado es verificar solo
códigos de error que forman parte del PEP257 convención oficial.

Todos los códigos de error anteriores se comprueban de forma predeterminada, excepto D203.

pydocstyle es un cambio de nombre y continuación de pep257, un proyecto creado por Vladimir Keleshev.

Mantenido por Amir Rachum.

Utilice pydocstyle en línea utilizando los servicios de onworks.net