构建Python包的五个简单准则简介
创建一个软件包（package）似乎已经足够简单了，也就是在文件目录下搜集一些模块，再加上一个__init__.py文件，对吧？我们很容易看出来，随着时间的推移，通过对软件包的越来越多的修改，一个设计很差的软件包可能会出现循环依赖问题，或是可能变得不可移植和不可靠。
1. __init__.py 仅为导入服务
对于一个简单的软件包，你可能会忍不住把工具方法，工厂方法和异常处理都丢进__init__.py，千万别这样！
一个结构良好的__init__.py文件，仅为一个非常重要的目的来服务：从子模块导入。你的__init__.py应该看起来像这个样子：
# ORDER MATTERS HERE -- SOME MODULES ARE DEPENDANT ON OTHERS
# 导入顺序要考虑——一些模块会依赖另外的一些
from exceptions import FSQError, FSQEnvError, FSQEncodeError,
FSQTimeFmtError, FSQMalformedEntryError,
FSQCoerceError, FSQEnqueueError, FSQConfigError,
FSQPathError, FSQInstallError, FSQCannotLockError,
FSQWorkItemError, FSQTTLExpiredError,
FSQMaxTriesError, FSQScanError, FSQDownError,
FSQDoneError, FSQFailError, FSQTriggerPullError,
FSQHostsError, FSQReenqueueError, FSQPushError
# constants relies on: exceptions, internal
import constants
# const relies on: constants, exceptions, internal
from const import const, set_const
# has tests
# path relies on: exceptions, constants, internal
import path
# has tests
# lists relies on: path
from lists import hosts, queues
#...
2.使用__init__.py来限制导入顺序
- 把方法和类置于软件包的作用域中，这样用户就不需要深入软件包的内部结构，使你的软包变得易用。
- 作为调和导入顺序的唯一地方。
使用得当的话，__init__.py 可以为你提供重新组织内部软件包结构的灵活性，而不需要担心由内部导入子模块或是每个模块导入顺序所带来的副作用。因为你是以一个特定的顺序导入子模块，你的__init__.py 对于他程序员来讲应该简单易懂，并且能够明显的表示该软件包所能提供的全部功能。
文档字符串，以及在软件包层面对__all__属性的赋值应当是__init__.py中唯一的与导入模块不相关的代码：
__all__ = [ 'FSQError', 'FSQEnvError', 'FSQEncodeError', 'FSQTimeFmtError',
'FSQMalformedEntryError', 'FSQCoerceError', 'FSQEnqueueError',
'FSQConfigError', 'FSQCannotLock', 'FSQWorkItemError',
'FSQTTLExpiredError', 'FSQMaxTriesError', 'FSQScanError',
'FSQDownError', 'FSQDoneError', 'FSQFailError', 'FSQInstallError',
'FSQTriggerPullError', 'FSQCannotLockError', 'FSQPathError',
'path', 'constants', 'const', 'set_const', 'down', 'up',
# ...
]
3.使用一个模块来定义所有的异常
你也许已经注意到了，__init__.py中的第一个导入语句从exceptions.py子模块中导入了全部的异常。从这里出发，你将看到，在大多数的软件包中，异常被定义在引起它们的代码附近。尽管这样可以为一个模块提供高度的完整性，一个足够复杂的软件包会通过如下两种方式，使得这一模式出现问题。
通常一个模块/程序需要从一个子模块导入一个函数, 利用它导入代码并抛出异常。为了捕获异常并保持一定的粒度，你需要导入你需要的模块，以及定义了异常的模块（或者更糟，你要导入一系列的异常）。这一系列衍生出来的导入需求，是在你的软件包中编织一张错综复杂的导入之网的始作俑者。你使用这种方式的次数越多，你的软件包内部就变的越相互依赖，也更加容易出错。
随着异常数量的不断增长，找到一个软件包可能引发的全部异常变的越来越难。把所有的异常定义在一个单独的模块中，提供了一个方便的地方，在这里，程序员可以审查并确定你的软件包所能引发全部潜在错误状态。
你应该为你的软件包的异常定义一个基类:
class APackageException(Exception): '''root for APackage Exceptions, only used to except any APackage error, never raised''' pass
然后确保你的软件包在任何错误状态下，只会引发这个基类异常的子类异常，这样如果你需要的话，你就可以阻止全部的异常：
try: '''bunch of code from your package''' except APackageException: '''blanked condition to handle all errors from your package'''
对于一般的错误状态，这里有一些重要的异常处理已经被包括在标准库中了（例如，TypeError, ValueError等）
灵活地定义异常处理并保持足够的粒度：
# from fsq
class FSQEnvError(FSQError):
'''An error if something cannot be loaded from env, or env has an invalid
value'''
pass
class FSQEncodeError(FSQError):
'''An error occured while encoding or decoding an argument'''
pass
# ... and 20 or so more
在你的异常处理中保持更大的粒度，有利于让程序员们在一个try/except中包含越来越大的，互相不干涉的代码段。
# this
try:
item = fsq.senqueue('queue', 'str', 'arg', 'arg')
scanner = fsq.scan('queue')
except FSQScanError:
'''do something'''
except FSQEnqueueError:
'''do something else'''
# not this
try:
item = fsq.senqueue('queue', 'str', 'arg', 'arg')
except FSQEnqueueError:
'''do something else'''
try:
scanner = fsq.scan('queue')
except FSQScanError:
'''do something'''
# and definitely not
try:
item = fsq.senqueue('queue', 'str', 'arg', 'arg')
try:
scanner = fsq.scan('queue')
except FSQScanError:
'''do something'''
except FSQEnqueueError:
'''do something else'''
在异常定义时保持高度的粒度，会减少错综复杂的错误处理，并且允许你把正常执行指令和错误处理指令分别开来，使你的代码更加易懂和更易维护。
4. 在软件包内部只进行相对导入
在子模块中你时常见到的一个简单错误，就是使用软件包的名字来导入软件包。
# within a sub-module from a_package import APackageError
这样做会导致两个不好的结果：
- 子模块只有当软件包被安装在 PYTHONPATH 内才能正确运行。
- 子模块只有当这个软件包的名字是 a_package 时才能正确运行。
尽管第一条看上去并不是什么大问题，但是考虑一下，如果你在 PYTHONPATH 下的两个目录中，有两个同名的软件包。你的子模块可能最终导入了另一个软件包，你将无意间使得某个或某些对此毫无戒备的程序员（或是你自己）debug 到深夜。
# within a sub-module
from . import FSQEnqueueError, FSQCoerceError, FSQError, FSQReenqueueError,
constants as _c, path as fsq_path, construct,
hosts as fsq_hosts, FSQWorkItem
from .internal import rationalize_file, wrap_io_os_err, fmt_time,
coerce_unicode, uid_gid
# you can also use ../... etc. in sub-packages.
5. 让模块保持较小的规模
你的模块应当比较小。记住，那个使用你软件包的程序员会在软件包作用域进行导入，同时你会使用你的 __init__.py 文件来作为一个组织工具，来暴露一个完整的接口。
好的做法是一个模块只定义一个类，伴随一些帮助方法和工厂方法来协助建立这个模块。
class APackageClass(object):
'''One class'''
def apackage_builder(how_many):
for i in range(how_many):
yield APackageClass()
如果你的模块暴露了一些方法，把一些相互依赖的方法分为一组放进一个模块，并且把不相互依赖的方法移动到单独的模块中：
####### EXPOSED METHODS #######
def enqueue(trg_queue, item_f, *args, **kwargs):
'''Enqueue the contents of a file, or file-like object, file-descriptor or
the contents of a file at an address (e.g. '/my/file') queue with
arbitrary arguments, enqueue is to venqueue what printf is to vprintf
'''
return venqueue(trg_queue, item_f, args, **kwargs)
def senqueue(trg_queue, item_s, *args, **kwargs):
'''Enqueue a string, or string-like object to queue with arbitrary
arguments, senqueue is to enqueue what sprintf is to printf, senqueue
is to vsenqueue what sprintf is to vsprintf.
'''
return vsenqueue(trg_queue, item_s, args, **kwargs)
def venqueue(trg_queue, item_f, args, user=None, group=None, mode=None):
'''Enqueue the contents of a file, or file-like object, file-descriptor or
the contents of a file at an address (e.g. '/my/file') queue with
an argument list, venqueue is to enqueue what vprintf is to printf
if entropy is passed in, failure on duplicates is raised to the caller,
if entropy is not passed in, venqueue will increment entropy until it
can create the queue item.
'''
# setup defaults
trg_fd = name = None
# ...
上面的例子是 fsq/enqueue.py，它暴露了一系列的方法来为同一个功能提供不同的接口（就像 simplejson 中的l oad/loads）。尽管这个例子足够直观，让你的模块保持较小规模需要一些判断，但是一个好的原则是：
当你有疑问的时候，就去创建一个新的子模块吧。
Outils d'IA chauds
Undresser.AI Undress
Application basée sur l'IA pour créer des photos de nu réalistes
AI Clothes Remover
Outil d'IA en ligne pour supprimer les vêtements des photos.
Undress AI Tool
Images de déshabillage gratuites
Clothoff.io
Dissolvant de vêtements AI
Video Face Swap
Échangez les visages dans n'importe quelle vidéo sans effort grâce à notre outil d'échange de visage AI entièrement gratuit !
Article chaud
Outils chauds
Bloc-notes++7.3.1
Éditeur de code facile à utiliser et gratuit
SublimeText3 version chinoise
Version chinoise, très simple à utiliser
Envoyer Studio 13.0.1
Puissant environnement de développement intégré PHP
Dreamweaver CS6
Outils de développement Web visuel
SublimeText3 version Mac
Logiciel d'édition de code au niveau de Dieu (SublimeText3)
Sujets chauds
PHP et Python: différents paradigmes expliqués
Apr 18, 2025 am 12:26 AM
PHP est principalement la programmation procédurale, mais prend également en charge la programmation orientée objet (POO); Python prend en charge une variété de paradigmes, y compris la POO, la programmation fonctionnelle et procédurale. PHP convient au développement Web, et Python convient à une variété d'applications telles que l'analyse des données et l'apprentissage automatique.
Python vs JavaScript: la courbe d'apprentissage et la facilité d'utilisation
Apr 16, 2025 am 12:12 AM
Python convient plus aux débutants, avec une courbe d'apprentissage en douceur et une syntaxe concise; JavaScript convient au développement frontal, avec une courbe d'apprentissage abrupte et une syntaxe flexible. 1. La syntaxe Python est intuitive et adaptée à la science des données et au développement back-end. 2. JavaScript est flexible et largement utilisé dans la programmation frontale et côté serveur.
Choisir entre PHP et Python: un guide
Apr 18, 2025 am 12:24 AM
PHP convient au développement Web et au prototypage rapide, et Python convient à la science des données et à l'apprentissage automatique. 1.Php est utilisé pour le développement Web dynamique, avec une syntaxe simple et adapté pour un développement rapide. 2. Python a une syntaxe concise, convient à plusieurs champs et a un écosystème de bibliothèque solide.
Peut-on exécuter le code sous Windows 8
Apr 15, 2025 pm 07:24 PM
VS Code peut fonctionner sur Windows 8, mais l'expérience peut ne pas être excellente. Assurez-vous d'abord que le système a été mis à jour sur le dernier correctif, puis téléchargez le package d'installation VS Code qui correspond à l'architecture du système et l'installez comme invité. Après l'installation, sachez que certaines extensions peuvent être incompatibles avec Windows 8 et doivent rechercher des extensions alternatives ou utiliser de nouveaux systèmes Windows dans une machine virtuelle. Installez les extensions nécessaires pour vérifier si elles fonctionnent correctement. Bien que le code VS soit possible sur Windows 8, il est recommandé de passer à un système Windows plus récent pour une meilleure expérience de développement et une meilleure sécurité.
Le code Visual Studio peut-il être utilisé dans Python
Apr 15, 2025 pm 08:18 PM
VS Code peut être utilisé pour écrire Python et fournit de nombreuses fonctionnalités qui en font un outil idéal pour développer des applications Python. Il permet aux utilisateurs de: installer des extensions Python pour obtenir des fonctions telles que la réalisation du code, la mise en évidence de la syntaxe et le débogage. Utilisez le débogueur pour suivre le code étape par étape, trouver et corriger les erreurs. Intégrez Git pour le contrôle de version. Utilisez des outils de mise en forme de code pour maintenir la cohérence du code. Utilisez l'outil de liaison pour repérer les problèmes potentiels à l'avance.
PHP et Python: une plongée profonde dans leur histoire
Apr 18, 2025 am 12:25 AM
PHP est originaire en 1994 et a été développé par Rasmuslerdorf. Il a été utilisé à l'origine pour suivre les visiteurs du site Web et a progressivement évolué en un langage de script côté serveur et a été largement utilisé dans le développement Web. Python a été développé par Guidovan Rossum à la fin des années 1980 et a été publié pour la première fois en 1991. Il met l'accent sur la lisibilité et la simplicité du code, et convient à l'informatique scientifique, à l'analyse des données et à d'autres domaines.
Comment exécuter des programmes dans Terminal Vscode
Apr 15, 2025 pm 06:42 PM
Dans VS Code, vous pouvez exécuter le programme dans le terminal via les étapes suivantes: Préparez le code et ouvrez le terminal intégré pour vous assurer que le répertoire de code est cohérent avec le répertoire de travail du terminal. Sélectionnez la commande Run en fonction du langage de programmation (tel que Python de Python your_file_name.py) pour vérifier s'il s'exécute avec succès et résoudre les erreurs. Utilisez le débogueur pour améliorer l'efficacité du débogage.
L'extension VScode est-elle malveillante?
Apr 15, 2025 pm 07:57 PM
Les extensions de code vs posent des risques malveillants, tels que la cachette de code malveillant, l'exploitation des vulnérabilités et la masturbation comme des extensions légitimes. Les méthodes pour identifier les extensions malveillantes comprennent: la vérification des éditeurs, la lecture des commentaires, la vérification du code et l'installation avec prudence. Les mesures de sécurité comprennent également: la sensibilisation à la sécurité, les bonnes habitudes, les mises à jour régulières et les logiciels antivirus.
