iframe-proxy | Sunbelt Computer Software

916 lines (799 loc) · 31.8 KB
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2001 Python Software Foundation
# This file is distributed under the same license as the Python package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
# Translators:
# Alireza Shabani (Revisto) <theRevisto@gmail.com>, 2025
"Project-Id-Version: Python 3.14\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-07-25 12:59+0330\n"
"PO-Revision-Date: 2021-06-28 01:50+0000\n"
"Last-Translator: Alireza Shabani (Revisto) <theRevisto@gmail.com>, 2025\n"
"Language-Team: Persian (https://app.transifex.com/python-doc/teams/5390/"
"Language: fa\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: ../../tutorial/modules.rst:5
msgid "Modules"
#: ../../tutorial/modules.rst:7
"If you quit from the Python interpreter and enter it again, the definitions "
"you have made (functions and variables) are lost. Therefore, if you want to "
"write a somewhat longer program, you are better off using a text editor to "
"prepare the input for the interpreter and running it with that file as input "
"instead.  This is known as creating a *script*.  As your program gets "
"longer, you may want to split it into several files for easier maintenance.  "
"You may also want to use a handy function that you've written in several "
"programs without copying its definition into each program."
#: ../../tutorial/modules.rst:16
"To support this, Python has a way to put definitions in a file and use them "
"in a script or in an interactive instance of the interpreter. Such a file is "
"called a *module*; definitions from a module can be *imported* into other "
"modules or into the *main* module (the collection of variables that you have "
"access to in a script executed at the top level and in calculator mode)."
#: ../../tutorial/modules.rst:22
"A module is a file containing Python definitions and statements.  The file "
"name is the module name with the suffix :file:`.py` appended.  Within a "
"module, the module's name (as a string) is available as the value of the "
"global variable ``__name__``.  For instance, use your favorite text editor "
"to create a file called :file:`fibo.py` in the current directory with the "
"following contents::"
#: ../../tutorial/modules.rst:28
"# Fibonacci numbers module\n"
"def fib(n):\n"
"    \"\"\"Write Fibonacci series up to n.\"\"\"\n"
"    a, b = 0, 1\n"
"    while a < n:\n"
"        print(a, end=' ')\n"
"        a, b = b, a+b\n"
"    print()\n"
"def fib2(n):\n"
"    \"\"\"Return Fibonacci series up to n.\"\"\"\n"
"    result = []\n"
"    a, b = 0, 1\n"
"    while a < n:\n"
"        result.append(a)\n"
"        a, b = b, a+b\n"
"    return result"
#: ../../tutorial/modules.rst:47
"Now enter the Python interpreter and import this module with the following "
"command::"
#: ../../tutorial/modules.rst:50
msgid ">>> import fibo"
#: ../../tutorial/modules.rst:52
"This does not add the names of the functions defined in ``fibo``  directly "
"to the current :term:`namespace` (see :ref:`tut-scopes` for more details); "
"it only adds the module name ``fibo`` there. Using the module name you can "
"access the functions::"
#: ../../tutorial/modules.rst:57
">>> fibo.fib(1000)\n"
">>> fibo.fib2(100)\n"
"[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]\n"
">>> fibo.__name__\n"
#: ../../tutorial/modules.rst:64
"If you intend to use a function often you can assign it to a local name::"
#: ../../tutorial/modules.rst:66
">>> fib = fibo.fib\n"
">>> fib(500)\n"
#: ../../tutorial/modules.rst:74
msgid "More on Modules"
#: ../../tutorial/modules.rst:76
"A module can contain executable statements as well as function definitions. "
"These statements are intended to initialize the module. They are executed "
"only the *first* time the module name is encountered in an import statement. "
"[#]_ (They are also run if the file is executed as a script.)"
#: ../../tutorial/modules.rst:81
"Each module has its own private namespace, which is used as the global "
"namespace by all functions defined in the module. Thus, the author of a "
"module can use global variables in the module without worrying about "
"accidental clashes with a user's global variables. On the other hand, if you "
"know what you are doing you can touch a module's global variables with the "
"same notation used to refer to its functions, ``modname.itemname``."
#: ../../tutorial/modules.rst:88
"Modules can import other modules.  It is customary but not required to place "
"all :keyword:`import` statements at the beginning of a module (or script, "
"for that matter).  The imported module names, if placed at the top level of "
"a module (outside any functions or classes), are added to the module's "
"global namespace."
#: ../../tutorial/modules.rst:93
"There is a variant of the :keyword:`import` statement that imports names "
"from a module directly into the importing module's namespace.  For example::"
#: ../../tutorial/modules.rst:96
">>> from fibo import fib, fib2\n"
">>> fib(500)\n"
#: ../../tutorial/modules.rst:100
"This does not introduce the module name from which the imports are taken in "
"the local namespace (so in the example, ``fibo`` is not defined)."
#: ../../tutorial/modules.rst:103
msgid "There is even a variant to import all names that a module defines::"
#: ../../tutorial/modules.rst:105
">>> from fibo import *\n"
">>> fib(500)\n"
#: ../../tutorial/modules.rst:109
"This imports all names except those beginning with an underscore (``_``). In "
"most cases Python programmers do not use this facility since it introduces "
"an unknown set of names into the interpreter, possibly hiding some things "
"you have already defined."
#: ../../tutorial/modules.rst:114
"Note that in general the practice of importing ``*`` from a module or "
"package is frowned upon, since it often causes poorly readable code. "
"However, it is okay to use it to save typing in interactive sessions."
#: ../../tutorial/modules.rst:118
"If the module name is followed by :keyword:`!as`, then the name "
"following :keyword:`!as` is bound directly to the imported module."
#: ../../tutorial/modules.rst:123
">>> import fibo as fib\n"
">>> fib.fib(500)\n"
#: ../../tutorial/modules.rst:127
"This is effectively importing the module in the same way that ``import "
"fibo`` will do, with the only difference of it being available as ``fib``."
#: ../../tutorial/modules.rst:130
"It can also be used when utilising :keyword:`from` with similar effects::"
#: ../../tutorial/modules.rst:132
">>> from fibo import fib as fibonacci\n"
">>> fibonacci(500)\n"
#: ../../tutorial/modules.rst:139
"For efficiency reasons, each module is only imported once per interpreter "
"session.  Therefore, if you change your modules, you must restart the "
"interpreter -- or, if it's just one module you want to test interactively, "
"use :func:`importlib.reload`, e.g. ``import importlib; "
"importlib.reload(modulename)``."
#: ../../tutorial/modules.rst:149
msgid "Executing modules as scripts"
#: ../../tutorial/modules.rst:151
msgid "When you run a Python module with ::"
#: ../../tutorial/modules.rst:153
msgid "python fibo.py <arguments>"
#: ../../tutorial/modules.rst:155
"the code in the module will be executed, just as if you imported it, but "
"with the ``__name__`` set to ``\"__main__\"``.  That means that by adding "
"this code at the end of your module::"
#: ../../tutorial/modules.rst:159
"if __name__ == \"__main__\":\n"
"    import sys\n"
"    fib(int(sys.argv[1]))"
#: ../../tutorial/modules.rst:163
"you can make the file usable as a script as well as an importable module, "
"because the code that parses the command line only runs if the module is "
"executed as the \"main\" file:"
#: ../../tutorial/modules.rst:167
"$ python fibo.py 50\n"
#: ../../tutorial/modules.rst:172
msgid "If the module is imported, the code is not run::"
#: ../../tutorial/modules.rst:174
">>> import fibo\n"
#: ../../tutorial/modules.rst:177
"This is often used either to provide a convenient user interface to a "
"module, or for testing purposes (running the module as a script executes a "
"test suite)."
#: ../../tutorial/modules.rst:184
msgid "The Module Search Path"
#: ../../tutorial/modules.rst:188
"When a module named :mod:`!spam` is imported, the interpreter first searches "
"for a built-in module with that name. These module names are listed "
"in :data:`sys.builtin_module_names`. If not found, it then searches for a "
"file named :file:`spam.py` in a list of directories given by the "
"variable :data:`sys.path`.  :data:`sys.path` is initialized from these "
"locations:"
#: ../../tutorial/modules.rst:194
"The directory containing the input script (or the current directory when no "
"file is specified)."
#: ../../tutorial/modules.rst:196
":envvar:`PYTHONPATH` (a list of directory names, with the same syntax as the "
"shell variable :envvar:`PATH`)."
#: ../../tutorial/modules.rst:198
"The installation-dependent default (by convention including a ``site-"
"packages`` directory, handled by the :mod:`site` module)."
#: ../../tutorial/modules.rst:201
msgid "More details are at :ref:`sys-path-init`."
#: ../../tutorial/modules.rst:204
"On file systems which support symlinks, the directory containing the input "
"script is calculated after the symlink is followed. In other words the "
"directory containing the symlink is **not** added to the module search path."
#: ../../tutorial/modules.rst:208
"After initialization, Python programs can modify :data:`sys.path`.  The "
"directory containing the script being run is placed at the beginning of the "
"search path, ahead of the standard library path. This means that scripts in "
"that directory will be loaded instead of modules of the same name in the "
"library directory. This is an error unless the replacement is intended.  See "
"section :ref:`tut-standardmodules` for more information."
#: ../../tutorial/modules.rst:221
msgid "\"Compiled\" Python files"
#: ../../tutorial/modules.rst:223
"To speed up loading modules, Python caches the compiled version of each "
"module in the ``__pycache__`` directory under the name :file:`module."
"{version}.pyc`, where the version encodes the format of the compiled file; "
"it generally contains the Python version number.  For example, in CPython "
"release 3.3 the compiled version of spam.py would be cached as ``__pycache__/"
"spam.cpython-33.pyc``.  This naming convention allows compiled modules from "
"different releases and different versions of Python to coexist."
#: ../../tutorial/modules.rst:231
"Python checks the modification date of the source against the compiled "
"version to see if it's out of date and needs to be recompiled.  This is a "
"completely automatic process.  Also, the compiled modules are platform-"
"independent, so the same library can be shared among systems with different "
"architectures."
#: ../../tutorial/modules.rst:236
"Python does not check the cache in two circumstances.  First, it always "
"recompiles and does not store the result for the module that's loaded "
"directly from the command line.  Second, it does not check the cache if "
"there is no source module.  To support a non-source (compiled only) "
"distribution, the compiled module must be in the source directory, and there "
"must not be a source module."
#: ../../tutorial/modules.rst:243
msgid "Some tips for experts:"
#: ../../tutorial/modules.rst:245
"You can use the :option:`-O` or :option:`-OO` switches on the Python command "
"to reduce the size of a compiled module.  The ``-O`` switch removes assert "
"statements, the ``-OO`` switch removes both assert statements and __doc__ "
"strings.  Since some programs may rely on having these available, you should "
"only use this option if you know what you're doing.  \"Optimized\" modules "
"have an ``opt-`` tag and are usually smaller.  Future releases may change "
"the effects of optimization."
#: ../../tutorial/modules.rst:253
"A program doesn't run any faster when it is read from a ``.pyc`` file than "
"when it is read from a ``.py`` file; the only thing that's faster about "
"``.pyc`` files is the speed with which they are loaded."
#: ../../tutorial/modules.rst:257
"The module :mod:`compileall` can create .pyc files for all modules in a "
"directory."
#: ../../tutorial/modules.rst:260
"There is more detail on this process, including a flow chart of the "
"decisions, in :pep:`3147`."
#: ../../tutorial/modules.rst:267
msgid "Standard Modules"
#: ../../tutorial/modules.rst:271
"Python comes with a library of standard modules, described in a separate "
"document, the Python Library Reference (\"Library Reference\" hereafter).  "
"Some modules are built into the interpreter; these provide access to "
"operations that are not part of the core of the language but are "
"nevertheless built in, either for efficiency or to provide access to "
"operating system primitives such as system calls.  The set of such modules "
"is a configuration option which also depends on the underlying platform.  "
"For example, the :mod:`winreg` module is only provided on Windows systems. "
"One particular module deserves some attention: :mod:`sys`, which is built "
"into every Python interpreter.  The variables ``sys.ps1`` and ``sys.ps2`` "
"define the strings used as primary and secondary prompts::"
#: ../../tutorial/modules.rst:283
">>> import sys\n"
">>> sys.ps1\n"
">>> sys.ps2\n"
">>> sys.ps1 = 'C> '\n"
"C> print('Yuck!')\n"
#: ../../tutorial/modules.rst:294
"These two variables are only defined if the interpreter is in interactive "
#: ../../tutorial/modules.rst:296
"The variable ``sys.path`` is a list of strings that determines the "
"interpreter's search path for modules. It is initialized to a default path "
"taken from the environment variable :envvar:`PYTHONPATH`, or from a built-in "
"default if :envvar:`PYTHONPATH` is not set.  You can modify it using "
"standard list operations::"
#: ../../tutorial/modules.rst:302
">>> import sys\n"
">>> sys.path.append('/ufs/guido/lib/python')"
#: ../../tutorial/modules.rst:309
msgid "The :func:`dir` Function"
#: ../../tutorial/modules.rst:311
"The built-in function :func:`dir` is used to find out which names a module "
"defines.  It returns a sorted list of strings::"
#: ../../tutorial/modules.rst:314
">>> import fibo, sys\n"
">>> dir(fibo)\n"
"['__name__', 'fib', 'fib2']\n"
">>> dir(sys)\n"
"['__breakpointhook__', '__displayhook__', '__doc__', '__excepthook__',\n"
" '__interactivehook__', '__loader__', '__name__', '__package__', "
"'__spec__',\n"
" '__stderr__', '__stdin__', '__stdout__', '__unraisablehook__',\n"
" '_clear_type_cache', '_current_frames', '_debugmallocstats', '_framework',\n"
" '_getframe', '_git', '_home', '_xoptions', 'abiflags', 'addaudithook',\n"
" 'api_version', 'argv', 'audit', 'base_exec_prefix', 'base_prefix',\n"
" 'breakpointhook', 'builtin_module_names', 'byteorder', 'call_tracing',\n"
" 'callstats', 'copyright', 'displayhook', 'dont_write_bytecode', "
"'exc_info',\n"
" 'excepthook', 'exec_prefix', 'executable', 'exit', 'flags', 'float_info',\n"
" 'float_repr_style', 'get_asyncgen_hooks', "
"'get_coroutine_origin_tracking_depth',\n"
" 'getallocatedblocks', 'getdefaultencoding', 'getdlopenflags',\n"
" 'getfilesystemencodeerrors', 'getfilesystemencoding', 'getprofile',\n"
" 'getrecursionlimit', 'getrefcount', 'getsizeof', 'getswitchinterval',\n"
" 'gettrace', 'hash_info', 'hexversion', 'implementation', 'int_info',\n"
" 'intern', 'is_finalizing', 'last_traceback', 'last_type', 'last_value',\n"
" 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path', 'path_hooks',\n"
" 'path_importer_cache', 'platform', 'prefix', 'ps1', 'ps2', "
"'pycache_prefix',\n"
" 'set_asyncgen_hooks', 'set_coroutine_origin_tracking_depth', "
"'setdlopenflags',\n"
" 'setprofile', 'setrecursionlimit', 'setswitchinterval', 'settrace', "
"'stderr',\n"
" 'stdin', 'stdout', 'thread_info', 'unraisablehook', 'version', "
"'version_info',\n"
" 'warnoptions']"
#: ../../tutorial/modules.rst:340
"Without arguments, :func:`dir` lists the names you have defined currently::"
#: ../../tutorial/modules.rst:342
">>> a = [1, 2, 3, 4, 5]\n"
">>> import fibo\n"
">>> fib = fibo.fib\n"
">>> dir()\n"
"['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']"
#: ../../tutorial/modules.rst:348
"Note that it lists all types of names: variables, modules, functions, etc."
#: ../../tutorial/modules.rst:352
":func:`dir` does not list the names of built-in functions and variables.  If "
"you want a list of those, they are defined in the standard "
"module :mod:`builtins`::"
#: ../../tutorial/modules.rst:356
">>> import builtins\n"
">>> dir(builtins)\n"
"['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException',\n"
" 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning',\n"
" 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError',\n"
" 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning',\n"
" 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False',\n"
" 'FileExistsError', 'FileNotFoundError', 'FloatingPointError',\n"
" 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError',\n"
" 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError',\n"
" 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError',\n"
" 'MemoryError', 'NameError', 'None', 'NotADirectoryError', "
"'NotImplemented',\n"
" 'NotImplementedError', 'OSError', 'OverflowError',\n"
" 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError',\n"
" 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning',\n"
" 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError',\n"
" 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError',\n"
" 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError',\n"
" 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning',\n"
" 'ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__',\n"
" '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs',\n"
" 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable',\n"
" 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits',\n"
" 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit',\n"
" 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr',\n"
" 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass',\n"
" 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview',\n"
" 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property',\n"
" 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice',\n"
" 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars',\n"
#: ../../tutorial/modules.rst:391
msgid "Packages"
#: ../../tutorial/modules.rst:393
"Packages are a way of structuring Python's module namespace by using "
"\"dotted module names\".  For example, the module name :mod:`!A.B` "
"designates a submodule named ``B`` in a package named ``A``.  Just like the "
"use of modules saves the authors of different modules from having to worry "
"about each other's global variable names, the use of dotted module names "
"saves the authors of multi-module packages like NumPy or Pillow from having "
"to worry about each other's module names."
#: ../../tutorial/modules.rst:401
"Suppose you want to design a collection of modules (a \"package\") for the "
"uniform handling of sound files and sound data.  There are many different "
"sound file formats (usually recognized by their extension, for "
"example: :file:`.wav`, :file:`.aiff`, :file:`.au`), so you may need to "
"create and maintain a growing collection of modules for the conversion "
"between the various file formats. There are also many different operations "
"you might want to perform on sound data (such as mixing, adding echo, "
"applying an equalizer function, creating an artificial stereo effect), so in "
"addition you will be writing a never-ending stream of modules to perform "
"these operations.  Here's a possible structure for your package (expressed "
"in terms of a hierarchical filesystem):"
#: ../../tutorial/modules.rst:412
"sound/                          Top-level package\n"
"      __init__.py               Initialize the sound package\n"
"      formats/                  Subpackage for file format conversions\n"
"              __init__.py\n"
"              wavread.py\n"
"              wavwrite.py\n"
"              aiffread.py\n"
"              aiffwrite.py\n"
"              auread.py\n"
"              auwrite.py\n"
"              ...\n"
"      effects/                  Subpackage for sound effects\n"
"              __init__.py\n"
"              echo.py\n"
"              surround.py\n"
"              reverse.py\n"
"              ...\n"
"      filters/                  Subpackage for filters\n"
"              __init__.py\n"
"              equalizer.py\n"
"              vocoder.py\n"
"              karaoke.py\n"
"              ..."
#: ../../tutorial/modules.rst:438
"When importing the package, Python searches through the directories on "
"``sys.path`` looking for the package subdirectory."
#: ../../tutorial/modules.rst:441
"The :file:`__init__.py` files are required to make Python treat directories "
"containing the file as packages (unless using a :term:`namespace package`, a "
"relatively advanced feature). This prevents directories with a common name, "
"such as ``string``, from unintentionally hiding valid modules that occur "
"later on the module search path. In the simplest case, :file:`__init__.py` "
"can just be an empty file, but it can also execute initialization code for "
"the package or set the ``__all__`` variable, described later."
#: ../../tutorial/modules.rst:449
"Users of the package can import individual modules from the package, for "
"example::"
#: ../../tutorial/modules.rst:452
msgid "import sound.effects.echo"
#: ../../tutorial/modules.rst:454
"This loads the submodule :mod:`!sound.effects.echo`.  It must be referenced "
"with its full name. ::"
#: ../../tutorial/modules.rst:457
msgid "sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)"
#: ../../tutorial/modules.rst:459
msgid "An alternative way of importing the submodule is::"
#: ../../tutorial/modules.rst:461
msgid "from sound.effects import echo"
#: ../../tutorial/modules.rst:463
"This also loads the submodule :mod:`!echo`, and makes it available without "
"its package prefix, so it can be used as follows::"
#: ../../tutorial/modules.rst:466
msgid "echo.echofilter(input, output, delay=0.7, atten=4)"
#: ../../tutorial/modules.rst:468
"Yet another variation is to import the desired function or variable "
"directly::"
#: ../../tutorial/modules.rst:470
msgid "from sound.effects.echo import echofilter"
#: ../../tutorial/modules.rst:472
"Again, this loads the submodule :mod:`!echo`, but this makes its "
"function :func:`!echofilter` directly available::"
#: ../../tutorial/modules.rst:475
msgid "echofilter(input, output, delay=0.7, atten=4)"
#: ../../tutorial/modules.rst:477
"Note that when using ``from package import item``, the item can be either a "
"submodule (or subpackage) of the package, or some  other name defined in the "
"package, like a function, class or variable.  The ``import`` statement first "
"tests whether the item is defined in the package; if not, it assumes it is a "
"module and attempts to load it.  If it fails to find it, "
"an :exc:`ImportError` exception is raised."
#: ../../tutorial/modules.rst:484
"Contrarily, when using syntax like ``import item.subitem.subsubitem``, each "
"item except for the last must be a package; the last item can be a module or "
"a package but can't be a class or function or variable defined in the "
"previous item."
#: ../../tutorial/modules.rst:493
msgid "Importing \\* From a Package"
#: ../../tutorial/modules.rst:497
"Now what happens when the user writes ``from sound.effects import *``?  "
"Ideally, one would hope that this somehow goes out to the filesystem, finds "
"which submodules are present in the package, and imports them all.  This "
"could take a long time and importing sub-modules might have unwanted side-"
"effects that should only happen when the sub-module is explicitly imported."
#: ../../tutorial/modules.rst:503
"The only solution is for the package author to provide an explicit index of "
"the package.  The :keyword:`import` statement uses the following convention: "
"if a package's :file:`__init__.py` code defines a list named ``__all__``, it "
"is taken to be the list of module names that should be imported when ``from "
"package import *`` is encountered.  It is up to the package author to keep "
"this list up-to-date when a new version of the package is released.  Package "
"authors may also decide not to support it, if they don't see a use for "
"importing \\* from their package.  For example, the file :file:`sound/"
"effects/__init__.py` could contain the following code::"
#: ../../tutorial/modules.rst:513
msgid "__all__ = [\"echo\", \"surround\", \"reverse\"]"
#: ../../tutorial/modules.rst:515
"This would mean that ``from sound.effects import *`` would import the three "
"named submodules of the :mod:`!sound.effects` package."
#: ../../tutorial/modules.rst:518
"Be aware that submodules might become shadowed by locally defined names. For "
"example, if you added a ``reverse`` function to the :file:`sound/effects/"
"__init__.py` file, the ``from sound.effects import *`` would only import the "
"two submodules ``echo`` and ``surround``, but *not* the ``reverse`` "
"submodule, because it is shadowed by the locally defined ``reverse`` "
"function::"
#: ../../tutorial/modules.rst:525
"__all__ = [\n"
"    \"echo\",      # refers to the 'echo.py' file\n"
"    \"surround\",  # refers to the 'surround.py' file\n"
"    \"reverse\",   # !!! refers to the 'reverse' function now !!!\n"
"def reverse(msg: str):  # <-- this name shadows the 'reverse.py' submodule\n"
"    return msg[::-1]    #     in the case of a 'from sound.effects import *'"
#: ../../tutorial/modules.rst:534
"If ``__all__`` is not defined, the statement ``from sound.effects import *`` "
"does *not* import all submodules from the package :mod:`!sound.effects` into "
"the current namespace; it only ensures that the package :mod:`!"
"sound.effects` has been imported (possibly running any initialization code "
"in :file:`__init__.py`) and then imports whatever names are defined in the "
"package.  This includes any names defined (and submodules explicitly loaded) "
"by :file:`__init__.py`.  It also includes any submodules of the package that "
"were explicitly loaded by previous :keyword:`import` statements.  Consider "
"this code::"
#: ../../tutorial/modules.rst:543
"import sound.effects.echo\n"
"import sound.effects.surround\n"
"from sound.effects import *"
#: ../../tutorial/modules.rst:547
"In this example, the :mod:`!echo` and :mod:`!surround` modules are imported "
"in the current namespace because they are defined in the :mod:`!"
"sound.effects` package when the ``from...import`` statement is executed.  "
"(This also works when ``__all__`` is defined.)"
#: ../../tutorial/modules.rst:552
"Although certain modules are designed to export only names that follow "
"certain patterns when you use ``import *``, it is still considered bad "
"practice in production code."
#: ../../tutorial/modules.rst:556
"Remember, there is nothing wrong with using ``from package import "
"specific_submodule``!  In fact, this is the recommended notation unless the "
"importing module needs to use submodules with the same name from different "
"packages."
#: ../../tutorial/modules.rst:565
msgid "Intra-package References"
#: ../../tutorial/modules.rst:567
"When packages are structured into subpackages (as with the :mod:`!sound` "
"package in the example), you can use absolute imports to refer to submodules "
"of siblings packages.  For example, if the module :mod:`!"
"sound.filters.vocoder` needs to use the :mod:`!echo` module in the :mod:`!"
"sound.effects` package, it can use ``from sound.effects import echo``."
#: ../../tutorial/modules.rst:573
"You can also write relative imports, with the ``from module import name`` "
"form of import statement.  These imports use leading dots to indicate the "
"current and parent packages involved in the relative import.  From "
"the :mod:`!surround` module for example, you might use::"
#: ../../tutorial/modules.rst:578
"from . import echo\n"
"from .. import formats\n"
"from ..filters import equalizer"
#: ../../tutorial/modules.rst:582
"Note that relative imports are based on the name of the current module's "
"package. Since the main module does not have a package, modules intended for "
"use as the main module of a Python application must always use absolute "
#: ../../tutorial/modules.rst:588
msgid "Packages in Multiple Directories"
#: ../../tutorial/modules.rst:590
"Packages support one more special attribute, :attr:`~module.__path__`.  This "
"is initialized to be a :term:`sequence` of strings containing the name of "
"the directory holding the package's :file:`__init__.py` before the code in "
"that file is executed.  This variable can be modified; doing so affects "
"future searches for modules and subpackages contained in the package."
#: ../../tutorial/modules.rst:597
"While this feature is not often needed, it can be used to extend the set of "
"modules found in a package."
#: ../../tutorial/modules.rst:602
msgid "Footnotes"
#: ../../tutorial/modules.rst:603
"In fact function definitions are also 'statements' that are 'executed'; the "
"execution of a module-level function definition adds the function name to "
"the module's global namespace."
#: ../../tutorial/modules.rst:186 ../../tutorial/modules.rst:269
#: ../../tutorial/modules.rst:350
msgid "module"
#: ../../tutorial/modules.rst:186
msgid "search"
#: ../../tutorial/modules.rst:186
msgid "path"
#: ../../tutorial/modules.rst:269
msgid "sys"
#: ../../tutorial/modules.rst:350
msgid "builtins"
#: ../../tutorial/modules.rst:495
msgid "__all__"
Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

modules.po

Latest commit

History

modules.po

File metadata and controls
