القائمة الرئيسية

الصفحات

Python 3 - Modules

ملاحظة : ليس كل شيء تمت ترجمته الى اللغة العربية وذلك لانه يعطي معنى لا يمكن الاعتماد عليه 

 A module allows you to logically organize your Python code. Grouping related code into a module makes the code easier to understand and use. A module is a Python object with arbitrarily named attributes that you can bind and reference.

Simply, a module is a file consisting of Python code. A module can define functions, classes and variables. A module can also include runnable code.

Example

The Python code for a module named aname normally resides in a file namedaname.py. Here is an example of a simple module, support.py −

تسمح لك الوحدة بتنظيم كود بايثون الخاص بك بشكل منطقي. يؤدي تجميع التعليمات البرمجية ذات الصلة في وحدة نمطية إلى تسهيل فهم الكود واستخدامه. الوحدة النمطية هي كائن Python بسمات مسماة بشكل عشوائي يمكنك ربطها والرجوع إليها. ببساطة ، الوحدة النمطية هي ملف يتكون من كود Python. يمكن للوحدة أن تحدد الوظائف والفئات والمتغيرات. يمكن أن تتضمن الوحدة أيضًا رمزًا قابلًا للتشغيل. مثال رمز Python للوحدة النمطية المسماة aname موجود عادةً في ملف يسمىaname.py. فيما يلي مثال على وحدة بسيطة ، support.py -

def print_func( par ):
   print "Hello : ", par
   return

The import Statement

You can use any Python source file as a module by executing an import statement in some other Python source file. The import has the following syntax −

بيان الاستيراد يمكنك استخدام أي ملف مصدر Python كوحدة نمطية عن طريق تنفيذ عبارة استيراد في ملف مصدر Python آخر. الاستيراد له الصيغة التالية -

import module1[, module2[,... moduleN]

When the interpreter encounters an import statement, it imports the module if the module is present in the search path. A search path is a list of directories that the interpreter searches before importing a module. For example, to import the module hello.py, you need to put the following command at the top of the script −

عندما يواجه المترجم عبارة استيراد ، فإنه يستورد الوحدة النمطية إذا كانت الوحدة موجودة في مسار البحث. مسار البحث هو قائمة بالأدلة التي يبحث عنها المترجم قبل استيراد وحدة نمطية. على سبيل المثال ، لاستيراد الوحدة النمطية hello.py ، تحتاج إلى وضع الأمر التالي أعلى البرنامج النصي -

#!/usr/bin/python3

# Import module support
import support

# Now you can call defined function that module as follows
support.print_func("Zara")

When the above code is executed, it produces the following result −

Hello : Zara

A module is loaded only once, regardless of the number of times it is imported. This prevents the module execution from happening repeatedly, if multiple imports occur.

يتم تحميل الوحدة مرة واحدة فقط ، بغض النظر عن عدد مرات استيرادها. هذا يمنع تنفيذ الوحدة النمطية من الحدوث بشكل متكرر ، في حالة حدوث عمليات استيراد متعددة.

The from...import Statement

Python's from statement lets you import specific attributes from a module into the current namespace. The from...import has the following syntax −

from modname import name1[, name2[, ... nameN]]

For example, to import the function fibonacci from the module fib, use the following statement −

#!/usr/bin/python3

# Fibonacci numbers module

def fib(n): # return Fibonacci series up to n
   result = []
   a, b = 0, 1
   while b < n:
      result.append(b)
      a, b = b, a + b
   return result
>>> from fib import fib
>>> fib(100)
[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

This statement does not import the entire module fib into the current namespace; it just introduces the item fibonacci from the module fib into the global symbol table of the importing module.

لا تستورد هذه العبارة الوحدة النمطية بالكامل Fib إلى مساحة الاسم الحالية ؛ إنه يقدم فقط العنصر فيبوناتشي من الوحدة النمطية فيبوناتشي في جدول الرموز العالمي للوحدة المستوردة.

The from...import * Statement

It is also possible to import all the names from a module into the current namespace by using the following import statement −

from modname import *

This provides an easy way to import all the items from a module into the current namespace; however, this statement should be used sparingly.

يوفر هذا طريقة سهلة لاستيراد جميع العناصر من وحدة نمطية إلى مساحة الاسم الحالية ؛ ومع ذلك ، يجب استخدام هذا البيان باعتدال.

Executing Modules as Scripts

Within a module, the module’s name (as a string) is available as the value of the global variable __name__. The code in the module will be executed, just as if you imported it, but with the __name__ set to "__main__".

Add this code at the end of your module −

#!/usr/bin/python3

# Fibonacci numbers module

def fib(n): # return Fibonacci series up to n
   result = []
   a, b = 0, 1
   while b < n:
      result.append(b)
      a, b = b, a + b
   return result
if __name__ == "__main__":
   f = fib(100)
   print(f)

When you run the above code, the following output will be displayed.

[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

Locating Modules

When you import a module, the Python interpreter searches for the module in the following sequences −

  • The current directory.

  • If the module is not found, Python then searches each directory in the shell variable PYTHONPATH.

  • If all else fails, Python checks the default path. On UNIX, this default path is normally /usr/local/lib/python3/.

The module search path is stored in the system module sys as the sys.path variable. The sys.path variable contains the current directory, PYTHONPATH, and the installation-dependent default.

The PYTHONPATH Variable

The PYTHONPATH is an environment variable, consisting of a list of directories. The syntax of PYTHONPATH is the same as that of the shell variable PATH.

Here is a typical PYTHONPATH from a Windows system −

PYTHONPATH هو متغير بيئة ، يتكون من قائمة من الدلائل. صيغة PYTHONPATH هي نفسها المستخدمة في متغير shell PATH. فيما يلي نموذج PYTHONPATH من نظام Windows -

set PYTHONPATH = c:\python34\lib;

And here is a typical PYTHONPATH from a UNIX system −

set PYTHONPATH = /usr/local/lib/python

Namespaces and Scoping

Variables are names (identifiers) that map to objects. A namespace is a dictionary of variable names (keys) and their corresponding objects (values).

  • A Python statement can access variables in a local namespace and in the global namespace. If a local and a global variable have the same name, the local variable shadows the global variable.

  • Each function has its own local namespace. Class methods follow the same scoping rule as ordinary functions.

  • Python makes educated guesses on whether variables are local or global. It assumes that any variable assigned a value in a function is local.

  • Therefore, in order to assign a value to a global variable within a function, you must first use the global statement.

  • The statement global VarName tells Python that VarName is a global variable. Python stops searching the local namespace for the variable.

For example, we define a variable Money in the global namespace. Within the function Money, we assign Money a value, therefore Python assumes Money as a local variable.

However, we accessed the value of the local variable Money before setting it, so an UnboundLocalError is the result. Uncommenting the global statement fixes the problem.

المتغيرات هي الأسماء (المعرفات) التي ترتبط بالكائنات. مساحة الاسم هي قاموس لأسماء المتغيرات (المفاتيح) والكائنات المقابلة لها (القيم). يمكن أن تصل تعليمة Python إلى متغيرات في مساحة اسم محلية وفي مساحة الاسم العالمية. إذا كان المتغير المحلي والمتغير العام لهما نفس الاسم ، فإن المتغير المحلي يقوم بتظليل المتغير العام. كل وظيفة لها مساحة الاسم المحلية الخاصة بها. تتبع طرق الفصل نفس قاعدة تحديد النطاق مثل الوظائف العادية. تقوم بايثون بعمل تخمينات مستنيرة حول ما إذا كانت المتغيرات محلية أو عالمية. يفترض أن أي متغير يتم تعيين قيمة له في دالة يكون محليًا. لذلك ، لتعيين قيمة لمتغير عام داخل دالة ، يجب عليك أولاً استخدام العبارة global. بيان VarName العام يخبر Python أن VarName هو متغير عام. توقف Python عن البحث في مساحة الاسم المحلية للمتغير. على سبيل المثال ، نحدد متغير Money في مساحة الاسم العالمية. ضمن الدالة Money ، نقوم بتعيين قيمة Money ، لذلك تفترض Python أن Money كمتغير محلي. ومع ذلك ، فقد وصلنا إلى قيمة المتغير المحلي Money قبل تعيينه ، وبالتالي فإن UnboundLocalError هو النتيجة. يؤدي إلغاء التعليق على البيان العالمي إلى حل المشكلة.


#!/usr/bin/python3

Money = 2000
def AddMoney():
   # Uncomment the following line to fix the code:
   # global Money
   Money = Money + 1

print (Money)
AddMoney()
print (Money)

The dir( ) Function

The dir() built-in function returns a sorted list of strings containing the names defined by a module.

The list contains the names of all the modules, variables and functions that are defined in a module. Following is a simple example −

ترجع الدالة المضمنة dir () قائمة مرتبة من السلاسل التي تحتوي على الأسماء المحددة بواسطة الوحدة النمطية. تحتوي القائمة على أسماء جميع الوحدات والمتغيرات والوظائف المحددة في الوحدة النمطية. فيما يلي مثال بسيط -


#!/usr/bin/python3

# Import built-in module math
import math

content = dir(math)
print (content)

When the above code is executed, it produces the following result −

['__doc__', '__file__', '__name__', 'acos', 'asin', 'atan', 
'atan2', 'ceil', 'cos', 'cosh', 'degrees', 'e', 'exp', 
'fabs', 'floor', 'fmod', 'frexp', 'hypot', 'ldexp', 'log',
'log10', 'modf', 'pi', 'pow', 'radians', 'sin', 'sinh', 
'sqrt', 'tan', 'tanh']

Here, the special string variable __name__ is the module's name, and __file__ is the filename from which the module was loaded.

The globals() and locals() Functions

The globals() and locals() functions can be used to return the names in the global and local namespaces depending on the location from where they are called.

  • If locals() is called from within a function, it will return all the names that can be accessed locally from that function.

  • If globals() is called from within a function, it will return all the names that can be accessed globally from that function.

The return type of both these functions is dictionary. Therefore, names can be extracted using the keys() function.

الدالات globals () و locals () يمكن استخدام الدالتين globals () و locals () لإرجاع الأسماء في مساحات الأسماء العامة والمحلية اعتمادًا على الموقع من حيث يتم استدعاؤها. إذا تم استدعاء locals () من داخل دالة ، فستُرجع جميع الأسماء التي يمكن الوصول إليها محليًا من تلك الوظيفة. إذا تم استدعاء globals () من داخل دالة ، فسيتم إرجاع جميع الأسماء التي يمكن الوصول إليها عالميًا من هذه الوظيفة. نوع الإرجاع لكل من هاتين الوظيفتين هو القاموس. لذلك ، يمكن استخراج الأسماء باستخدام وظيفة keys ().

The reload() Function

When a module is imported into a script, the code in the top-level portion of a module is executed only once.

Therefore, if you want to reexecute the top-level code in a module, you can use the reload() function. The reload() function imports a previously imported module again. The syntax of the reload() function is this −

عندما يتم استيراد وحدة نمطية إلى برنامج نصي ، يتم تنفيذ التعليمات البرمجية الموجودة في الجزء ذي المستوى الأعلى من الوحدة مرة واحدة فقط. لذلك ، إذا كنت ترغب في إعادة تنفيذ رمز المستوى الأعلى في وحدة نمطية ، يمكنك استخدام وظيفة إعادة التحميل (). تستورد الدالة reload () وحدة نمطية سبق استيرادها مرة أخرى. بناء جملة وظيفة إعادة التحميل () هو كما يلي -

reload(module_name)

Here, module_name is the name of the module you want to reload and not the string containing the module name. For example, to reload hello module, do the following −

reload(hello)

Packages in Python

A package is a hierarchical file directory structure that defines a single Python application environment that consists of modules and subpackages and sub-subpackages, and so on.

Consider a file Pots.py available in Phone directory. This file has the following line of source code −

الحزمة عبارة عن بنية دليل ملف هرمي تحدد بيئة تطبيق Python واحدة تتكون من وحدات وحزم فرعية وحزم فرعية ، وما إلى ذلك. ضع في اعتبارك ملف Pots.py متاحًا في دليل الهاتف. يحتوي هذا الملف على السطر التالي من التعليمات البرمجية المصدر -

#!/usr/bin/python3

def Pots():
print ("I'm Pots Phone")  

Similar, we have other two files having different functions with the same name as above. They are −

  • Phone/Isdn.py file having function Isdn()

  • Phone/G3.py file having function G3()

Now, create one more file __init__.py in the Phone directory −

  • Phone/__init__.py

To make all of your functions available when you have imported Phone, you need to put explicit import statements in __init__.py as follows −

from Pots import Pots
from Isdn import Isdn
from G3 import G3

After you add these lines to __init__.py, you have all of these classes available when you import the Phone package.

#!/usr/bin/python3

# Now import your Phone Package.
import Phone

Phone.Pots()
Phone.Isdn()
Phone.G3()

When the above code is executed, it produces the following result −

I'm Pots Phone
I'm 3G Phone
I'm ISDN Phone

In the above example, we have taken example of a single function in each file, but you can keep multiple functions in your files. You can also define different Python classes in those files and then you can create your packages out of those classes.

في المثال أعلاه ، أخذنا مثالاً لوظيفة واحدة في كل ملف ، ولكن يمكنك الاحتفاظ بوظائف متعددة في ملفاتك. يمكنك أيضًا تحديد فئات Python المختلفة في تلك الملفات ، وبعد ذلك يمكنك إنشاء حزمك من هذه الفئات.

هل اعجبك الموضوع :

تعليقات