برنامه نویسی | Teachify

⌨️ کاربرد متغیر __all__ در پایتون!

متغیر __all__ در پایتون ابزاری قدرتمند برای کنترل نحوه دسترسی به اجزای یک ماژول یا پکیج است. این متغیر، یک لیست یا تاپل از رشته‌ها (strings) است که مشخص می‌کند کدام اجزا (توابع، کلاس‌ها، متغیرها و غیره) زمانی که کاربر از دستور from module import * استفاده می‌کند، ایمپورت می‌شوند. در ادامه، همه کاربردهای مهم __all__ را به همراه مثال‌های مرتبط توضیح می‌دهم.

1. کنترل محتوای ایمپورت‌ها (from module import *)

این کاربرد اصلی __all__ است. زمانی که __all__ در یک ماژول یا پکیج تعریف می‌شود، تنها آیتم‌هایی که در این لیست آمده‌اند هنگام استفاده از from module import * ایمپورت می‌شوند.

مثال:

فرض کنید شما یک فایل module.py دارید که شامل چند تابع و کلاس است:

# module.py

def func1():
    return "This is func1"

def func2():
    return "This is func2"

class MyClass:
    pass

__all__ = ['func1', 'MyClass']

در این مثال، __all__ مشخص می‌کند که تنها func1 و MyClass باید ایمپورت شوند:

# importing all from module
from module import *

print(func1())  # "This is func1"
print(MyClass)  # <class 'module.MyClass'>

# The following will raise an AttributeError
print(func2())  # AttributeError: module 'module' has no attribute 'func2'

اینجا func2 ایمپورت نمی‌شود، چرا که در __all__ ذکر نشده است.

2. پنهان کردن اعضای داخلی ماژول

با استفاده از __all__ می‌توانید اجزای داخلی یک ماژول را از دسترسی عمومی پنهان کنید، به خصوص در مواردی که نمی‌خواهید کاربران به صورت ناخواسته به کدهای خصوصی یا توابعی که برای استفاده داخلی هستند، دسترسی داشته باشند.

مثال:

# module_internal.py

def _internal_func():
    return "This is an internal function"

def public_func():
    return "This is a public function"

__all__ = ['public_func']

در اینجا، حتی اگر _internal_func تعریف شده باشد، استفاده از from module_internal import * تنها public_func را در دسترس قرار می‌دهد:

from module_internal import *

print(public_func())  # "This is a public function"

# The following will raise an AttributeError
print(_internal_func())  # AttributeError: module 'module_internal' has no attribute '_internal_func'

3. افزایش وضوح و مستندسازی

__all__ به نوعی مستندات ضمنی فراهم می‌کند. وقتی توسعه‌دهندگان دیگر به کد شما نگاه می‌کنند، با مشاهده __all__ می‌توانند به سرعت متوجه شوند که کدام بخش‌ها از کد برای استفاده عمومی طراحی شده‌اند و کدام بخش‌ها خصوصی یا برای استفاده داخلی هستند.

مثال:

در یک ماژول بزرگ، شما می‌توانید با استفاده از __all__ مشخص کنید کدام قسمت‌ها برای کاربران نهایی (End Users) طراحی شده‌اند:

# large_module.py

def public_func1():
    pass

def public_func2():
    pass

def _private_func():
    pass

__all__ = ['public_func1', 'public_func2']

این کار باعث می‌شود که هم توسعه‌دهندگان دیگر و هم کاربرانی که کد شما را استفاده می‌کنند، به سرعت متوجه شوند که کدام بخش‌ها از این ماژول برای استفاده عمومی طراحی شده‌اند.

4. کنترل محتوای ایمپورت در پکیج‌ها

در پکیج‌ها، __all__ در فایل __init__.py قرار می‌گیرد تا مشخص کند کدام اجزا از زیرماژول‌ها باید به صورت عمومی در دسترس باشند.

مثال:

فرض کنید پکیجی به نام mypackage دارید که شامل دو ماژول module1.py و module2.py است:

# mypackage/module1.py

class Class1:
    pass

# mypackage/module2.py

class Class2:
    pass

# mypackage/__init__.py

from .module1 import Class1
from .module2 import Class2

__all__ = ['Class1']

در اینجا، حتی اگر Class2 در module2 وجود دارد و در __init__.py نیز ایمپورت شده، اما چون در __all__ ذکر نشده است، تنها Class1 هنگام استفاده از from mypackage import * ایمپورت می‌شود:

from mypackage import *

print(Class1)  # <class 'mypackage.module1.Class1'>

# The following will raise an AttributeError
print(Class2)  # AttributeError: module 'mypackage' has no attribute 'Class2'

💻

@Teachify | برنامه نویسی

Please open Telegram to view this post