Préface

--J'ai un compte Github, mais je n'ai rien publié ――Je veux parfois un outil de vérification de texte à usage général, mais je ne le voulais pas vraiment, alors faisons-le et publions-le! ――J'ai entendu dire que la prochaine entreprise utilise CircleCI

Il existe également un plan gratuit, alors utilisons-le! «Je vais noter les points que j'ai subis en faisant ce qui précède.

J'ai créé un outil pour formater et valider les dates en Python

GitHub：https://github.com/nir-takemi/text_verifier
Une atmosphère comme celle-ci (AAAA / MM / JJ (w) hh: mm est défini dans le format correct)

[Err file path]/Users/xxxx/Documents/test.txt
[Err]Date format does't conform to rules: ２０１６/2/29 (lundi) 23:59
[Err]Date format does't conform to rules: 2016/2/29 (Mois) 23：59
[Err]Date format does't conform to rules(NG list): \n2/29 (lundi) 23:59
[Err]2016/2/30 isn't exist: 2016/2/30 (mar.) 23:59

«Je voulais vérifier divers textes à l'avenir, alors je l'ai nommé text_ en gros.

Difficultés à créer des outils

À propos des conventions de dénomination Python

J'ai été autorisé à faire référence! : Liste des règles de dénomination Python

Mettez-vous le code de test?

――Je mettrai la conclusion

Le code de test est également inclus dans TensorFlow publié par Google dans le monde, j'ai donc décidé que c'était correct de le mettre. ――Comme je le décrirai plus tard, lorsque vous voulez tester avec CircleCI, cela semble gênant s'il ne fait pas partie du projet, vous devez donc le mettre

Qu'est-ce qu'une bonne bibliothèque pour écrire un test?

--Sélectionnez pytest. «J'étais inquiet pour unittest, mais quand j'ai demandé à une personne expérimentée de Python, c'était intuitivement facile à comprendre, j'ai donc choisi pytest. C'est un outil simple, vous n'avez donc pas à vous perdre à ce stade, et vous pouvez l'enrouler autour de longs.

J'ai été autorisé à faire référence! : Remarques sur la mise en route de pytest

À quoi ressemble la hiérarchie des fichiers Python en premier lieu?

――Conclusion je l'ai fait comme ça

tree .
.
├── tests #Test lié
│   ├── conftest.py
│   └── test_text_verifier.py
├── textverifier #Module principal lié
│   ├── config.yaml
│   ├── pattern.yaml
│   └── text_verifier.py
└── verify_text.py #Existence qui ne s'exécute que

C'est un test unitaire, mais je l'ai utilisé comme référence! : Structure du répertoire lors de l'écriture de tests avec unittest standard Python 3

Je ne peux pas exécuter pytest car je ne peux pas charger le module ...

La conclusion est que j'ai créé conftest.py (qui est exécuté comme un pré-processus pour l'ensemble du test) et décrit le processus pour passer le chemin relatif du répertoire du module. --Référence
Importer en spécifiant directement le chemin du répertoire
Introduction à pytest --Notes de combats d'ingénieurs informatiques --Dans la hiérarchie de fichiers ci-dessus, j'ai importé le module comme suit

from text_verifier import TextVerifier

Mais une telle erreur

ImportError while importing test module 'xxx'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
tests/test_text_verifier.py:5: in <module>
    from text_verifier import TextVerifier
E   ModuleNotFoundError: No module named 'text_verifier'

Donc, j'ai écrit conftest.py sous le répertoire de test comme suit.

`conftest.py`


import sys 
import os

sys.path.append(os.path.abspath(os.path.dirname(os.path.abspath(__file__)) + "/../textverifier/"))

À propos de CircleCI

commencer

J'ai été autorisé à faire référence! : Je viens de démarrer CircleCI, je l'ai donc résumé de manière simple à comprendre
En gros, j'ai fait ce qui suit pour exécuter le test
Enregistrement du cercle CI --Lien avec GitHub --Créez config.yml dans le projet côté GitHub --Installez Docker & CicleCI localement et répétez le test de vérification du config.yml créé --Pousser config.yml sur GitHub --Si vous le poussez, il sera exécuté côté CicleCI.
Au fait, le dernier config.yml ressemble à ceci

version: 2
jobs:
  build:
    docker:
      - image: circleci/python:latest
    steps:
      - checkout

      - run:
          command: |
            sudo pip install pipenv
            pipenv install
            pipenv run pip install pyyaml
            pipenv run pip install pytest
            pipenv run pytest

Je souhaite afficher le lot CircleCI car c'est un gros problème

C'est la partie de la lecture de moi sur GitHub 　
J'ai été autorisé à faire référence! : Afficher le badge CircleCI sur README.md sur github

Le résultat du test fait-il une erreur?

--Créez un état où une erreur se produit une fois dans le test local --push! & Run! (Échec correctement!)

L'erreur était la même que l'erreur locale et elle est devenue ÉCHOUÉE à cet endroit. --Le lot a également échoué

Impressions

En ce qui concerne l'outil, je l'ai remarqué après l'avoir créé, mais il y en avait aussi un pratique appelé textlint ... Je voulais vérifier le format de correspondance pour cet outil. Donc ça va, mais j'ai senti que le contrôle de validité était bon avec textlint ――Parce que je suis Oncle Jenkins depuis longtemps, c'était assez significatif de connaître le ciment de CircleCI! J'avais l'habitude de mettre le fichier de configuration (shell d'exécution, etc.) côté serveur, donc c'était frais de le mettre côté référentiel (GitHub Actions ressent la même chose?) ――Comme c'est toujours la ligne de départ, j'aimerais en particulier jouer avec CircleCI ... «Ensuite, je veux faire quelque chose qui puisse être publié sur PyPI.

L'histoire de la sortie d'un outil de vérification de texte créé par Python sur GitHub x CircleCI pour la première fois