Python: 'Privé' module dans un package

J'ai un forfait mypack avec des modules mod_a et mod_b en elle. J'ai l'intention de le le package lui-même et mod_a être importés librement:

import mypack
import mypack.mod_a

Cependant, j'aimerais garder mod_b pour l'usage exclusif de mypack. C'est parce qu'il existe simplement pour organiser le dernier code interne.

Ma première question est, est-il une pratique acceptée dans la programmation Python pour avoir "privé" des modules de ce genre?

Si oui, ma deuxième question est, quelle est la meilleure façon de transmettre cette intention pour le client? Dois-je le préfixe du nom par un trait de soulignement (c'est à dire _mod_b)? Ou serait-ce une bonne idée de déclarer un sous-package private et placer tous les modules?

InformationsquelleAutor Frederick The Fool | 2010-08-30
  1. 33

    Je préfixe modules privés avec un trait de soulignement pour communiquer l'intention de l'utilisateur. Dans votre cas, ce serait mypack._mod_b

    C'est dans le même esprit (mais pas tout à fait analogue) la PEP8 recommandation pour le nom de C-modules d'extension avec un trait de soulignement quand il est enveloppé par un module Python; c'est à dire, _socket et socket.

    • En fait PEP8 dit: Even with __all__ set appropriately, internal interfaces (packages, modules, classes, functions, attributes or other names) should still be prefixed with a single leading underscore.
    InformationsquelleAutor Jeremy
  2. 14

    La solution que j'ai réglé sur est de créer un sous-package "privé" et le lieu de tous les modules que je souhaite cacher là-dedans. De cette façon, ils restent rangé dans un coin, laissant mypacks'module liste plus propre et plus facile à analyser.

    Pour moi, cela n'a pas l'air unpythonic soit.

    • Je suis venue à ce post de près de 6 ans plus tard, avec les mêmes questions et les mêmes motivations que vous avez eu. Privé sous-package approche toujours celui que vous prenez ou avez-vous essayé d'autres approches depuis?
    • Oui. Je suis toujours à l'aide de cette méthode. N'ai pas trouvé de meilleure alternative.
    • Merci pour la mise à jour et à la formulation de cette approche dans la première place. Je le préfixe "privé" sous-nom du package avec un "z_", de sorte qu'il apparaît en dernier dans l'IDE de l'achèvement de code des listes déroulantes. J'utilise relative des importations dans le sous-package __init__.py seulement à exposer le "public" des fonctions. Dans PyCharm et Jupyter, de garder les noms des modules internes de listes déroulantes, chaque module doit avoir une fonction avec le même nom que le module, et je doit importer la fonction dans __init__.py. Vous le savez probablement déjà tout cela, mais si ce n'est pas ici qu'il est. Si vous voulez me faire élargir comme une réponse dites le moi.
    InformationsquelleAutor Frederick The Fool
  3. 6

    Alors qu'il n'y a pas explicite privé de mots-clés, il s'agit d'une convention pour la mise privé des fonctions de démarrer avec un seul trait de soulignement, mais un double trait de soulignement va apporter afin que d'autres ne peuvent pas facilement à l'appel de la fonction à partir de l'extérieur du module. Voir la suite de PEP 8

    - _single_leading_underscore: weak "internal use" indicator.  E.g. "from M
  import *" does not import objects whose name starts with an underscore.

- single_trailing_underscore_: used by convention to avoid conflicts with
  Python keyword, e.g.

  Tkinter.Toplevel(master, class_='ClassName')

- __double_leading_underscore: when naming a class attribute, invokes name
  mangling (inside class FooBar, __boo becomes _FooBar__boo; see below).

- __double_leading_and_trailing_underscore__: "magic" objects or
  attributes that live in user-controlled namespaces.  E.g. __init__,
  __import__ or __file__.  Never invent such names; only use them
  as documented.

    Pour effectuer l'ensemble d'un module de privé, ne sont pas __init__.py fichier.

    • Aterrel, qu'entendez-vous par "ne pas inclure dans __init__.py"? Voulez-vous dire de ne pas placer la déclaration import mod_b dans __init__.py? Si oui, n'est toujours pas à résoudre mon problème. Le client peut toujours importer mod_b comme un module public: import mypack.mod_b. Ou voulez-vous dire quelque chose d'autre?
    • Afin de ne pas appliquer strictement le module privé, comme un seul trait de soulignement est faible. Mais il n'apparaît pas, sans explicitement de l'importer, ce qui est assez privé. J'imagine que vous pouvez nommer le fichier avec les deux principaux traits de soulignement, mais je n'ai jamais joué avec cette.
    • Merci pour la réponse aterrel. La solution, je suis à la décantation consiste à créer un sous-paquetage private sous mypack et de placer tous les modules que je veux "cacher" dans cette. Cela sert mon but de rendre mon code plus facile à explorer (par intellisense, par exemple), en rabattant tous les inutiles peluches.
    InformationsquelleAutor aterrel
  4. 2

    Python n'est pas strictement savoir ou de soutien "privé" ou "protégé" des méthodes ou classes. Il y a une convention que les méthodes préfixé avec un seul trait de soulignement ne font pas partie d'un fonctionnaire de l'API, mais je ne voudrais pas le faire sur des classes ou des fichiers - c'est moche.

    Si quelqu'un a vraiment besoin d'une sous-classe ou d'accès mod_b, pourquoi l'empêcher de le faire? Vous pouvez toujours fournir un préféré de l'API dans votre documentation et de document dans votre module que vous ne devriez pas y accéder directement et d'utiliser mypack en place.

    • J'ai pu quitter mod_b accessible tout comme mod_a. Cependant, l'imaginer il y a 20 modules semblable à mod_b. Ainsi, lorsque les types de clients mypack. dans l'éditeur, l'intellisense liste de tous les 25 ou privées ainsi que les modules. Cela permettra de rendre mon code plus difficile à explorer. C'est la raison pour laquelle je tiens à "cacher" les modules qui ne sont pas destinés pour le client. Quant à la documentation, les gens préfèrent généralement l'exploration à la lecture de la documentation.
    • Comme Matt Menuisier lui a dit de ne pas importer mod_b dans votre __init__.py. Je vous suggère de regarder le __all__ variable spéciale. Si aucun de ceux que le travail soit fait, le problème est dans Intellisense.
    • ssokolow, voir le troisième commentaire sous Matt réponse. Même lorsque mod_b n'est pas importé dans mypack/__init__.py, en tapant import mypack.mod_b dans le code du client travaille toujours avec succès. C'est parce que Python ne nécessite pas l'importation de modules imbriqués dans le top niveau pour "dot" importations (comme mypack.mod_b) au travail.
    InformationsquelleAutor Ivo van der Wijk