Hướng dẫn init py python - init py python

Trong phần 2 này, chúng ta sẽ cùng nhau tìm hiểu thêm về python package và module.

1. Python packages

Một cách đơn giản nhất, nếu module chỉ đơn thuần là file có đuôi là .py, thì package có thể xem là directory chứa các modules.module chỉ đơn thuần là file có đuôi là .py, thì package có thể xem là directory chứa các modules.

Packages là phương pháp để quản lý python's module namspace bằng cách sử dụng "dotted module names". Ví dụ, khi gõ module name A.B, điều này có nghĩa là ta đang chỉ định tới module B ở bên trong package A.dotted module names". Ví dụ, khi gõ module name A.B, điều này có nghĩa là ta đang chỉ định tới module B ở bên trong package A.

Tương tự như việc sử dụng module để giúp người viết module không phải lo lắng là bị trùng tên biến/hàm ở các module của người khác viết, việc sử dụng dotted module names sẽ giúp người viết multi-module packages như là NumPy hay Pillow không phải lo lắng về việc bị trùng tên module với người khác.trùng tên biến/hàm ở các module của người khác viết, việc sử dụng dotted module names sẽ giúp người viết multi-module packages như là NumPy hay Pillow không phải lo lắng về việc bị trùng tên module với người khác.

2. Import statement

Giả sử như bạn muốn design một collection of modules ( a "package") để xử lý các sound files và sound data. Các sound file này sẽ có rất nhiều format khác nhau (thông thường được nhận biết thông qua extension của chúng, ví dụ:

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Tiếp theo, sẽ có rất nhiều tác vụ mà bạn muốn thực hiện trên sound data (ví dụ như mixing, thêm echo, áp dụng equalizer function, tạo ra các hiệu ứng âm thanh,..), như vậy, khả năng là chúng ta sẽ phải viết một loạt các module kéo dài vô tận để thực hiện các tác vụ này. Dưới đây là một cấu trúc của package mà chúng ta có thể sử dụng:

sound/                          Top-level package
      __init__.py               Initialize the sound package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...

File

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Trong trường hợp đơn giản nhất, thì

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Người dùng của package có thể import riêng rẽ từng module, ví dụ:

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Một cách khác để import cái submodule:

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

Hoặc ta có thể tiến xa hơn nữa, import thẳng cái function vào symbol table luôn:

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

So sánh

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Với

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Về thứ tự, thì import statement sẽ kiểm tra xem cái tên đó có phải là một định nghĩa trong cái package đó hay không (function, class, variable), nếu không có, thì nó sẽ ngầm hiểu đây là module và thử load module.

Với

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

3. Package Relative Imports

Khi mà package được cấu trúc thành các subpackages (như ví dụ cái

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

Ví dụ, nếu module

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

Hoặc, ta có thể viết releative import, vẫn sử dụng dạng

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from . import echo
from .. import formats
from ..filters import equalizer
from .echo import echofilter

Note: với absolute import thì ta có thể sử dụng hoặc là

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

import XXX.YYY.ZZZ

thì

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

4. __all__ variable

Có một câu hỏi, là chuyện gì xảy ra khi người dùng viết

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

Trường hợp lý tưởng nhất, là bên trong file

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

__all__ = ["echo", "surround", "reverse"]

Khi đó, interpreter sẽ chỉ import các module có name được cung cấp trong danh sách này.

Trường hợp biến

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

import sound.effects.echo
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

Tới đây, thì ta sẽ thấy hai cách dưới đây là tương đương nhau:

import sound.effects.echo
import sound.effects.surround
import sound.effects.reverse

Hoặc

from sound.effects import *

Tuy cả 2 cách đều cho ra kết quả như nhau,

from . import echo
from .. import formats
from ..filters import equalizer
from .echo import echofilter

from . import echo
from .. import formats
from ..filters import equalizer
from .echo import echofilter

from . import echo
from .. import formats
from ..filters import equalizer
from .echo import echofilter