|
|
|
|
Python: Como criar um módulo
Início
1. Introdução
Um módulo em Python mais não é do que um conjunto de ficheiros ".py".
No entanto, se se deseja estruturá-lo devidamente, devem incluir-se ficheiros de setup, de licença e um readme.
Início
2. Como se cria um módulo simples e se lhe acede
Neste caso, um módulo não é mais do que um código dentro de um ficheiro ".py",
no entanto, é conveniente dar-lhe uma estrutura mais organizada:
pasta/
└── src/
└── Modulo_Name/
├── __init__.py
└── example.py
Início
3. Criar um módulo com diversos ficheiros
Cria-se uma pasta e nela uma nova pasta com o nome do módulo com se pode ver abaixo:
pasta/
├── LICENSE.txt
├── README.md
├── pyproject.toml
├── src/
│ └── example_package_YOUR_USERNAME_HERE/
│ ├── __init__.py
│ └── ... ficheiros ... .py
└── tests/
Na segunda pasta cria-se um ficheiro vazio com o nome "__init__.py" e
um ou mais ficheiros ".py" com o código desejado.
Na primeira pasta criam-se os ficheiros "LICENSE.txt" e
"README.md" respectivamente com a licença do software (GNU, ou outra)
e outro, "pyproject.toml", com informações sobre o módulo, de acordo
com o modelo abaixo:
# pyproject.toml
[project]
name = "??__Nome do módulo__"
version = "??__versao__ 0.1"
authors = [
{ name="__Nome do criador__", email="__Email do criador__" },
]
description = "??__Descrição do módulo__"
readme = "README.md"
requires-python = ">=3.9"
classifiers = [
"Programming Language :: Python :: 3",
"Operating System :: OS Independent",
]
# license = "GNU"
# license-files = ["LICENCE.txt"]
#
[project.urls]
Homepage = "__URL__"
Issues = "__URL__"
em que os campos indicados por "??" devem ficar devidamente preenchidos.
Uma vez concluída a criação do módulo, vamos para a primeira pasta criada e executamos
os comandos abaixo que irão criar uma pasta "dist"
com dois ficheiros: um "tar.gz" que contirá distribuição e
outro "whl" com informações sobre o módulo:
- Para executar em Unix / masOS:
python3 -m pip install --upgrade build
python3 -m build
- Para executar em Microsoft Windows:
py -m pip install --upgrade build
py -m build
e, em seguida, instalamos o pacote criado:
pip install ./dist/__Ficheiro_criado_com_o_comando_anterior__.tar.gz
finalmente, para importar o módulo dentro do Python fazer:
from __Nome_do_Modulo__ import __Nome_do_Modulo__
Início
4. Como colocar num repositório e fazer o seu registo
Se desejar colocar o seu módulo num repositório e ter a sua licença pode ver no site
Packaging Python Projects.
Início
5. Links úteis
Início
|
|
|
|