Hướng dẫn how are python projects organized? - các dự án python được tổ chức như thế nào?

Giống như các bài báo? Mua sách! Dead Simple Python của Jason C. McDonald có sẵn từ No Starch Press.Dead Simple Python by Jason C. McDonald is available from No Starch Press.

Phần tồi tệ nhất của hướng dẫn luôn luôn là sự đơn giản của họ, phải không? Hiếm khi bạn sẽ tìm thấy một cái có nhiều hơn một tệp, hiếm khi hơn nhiều với nhiều thư mục.

Tôi đã thấy rằng cấu trúc một dự án Python là một trong những thành phần thường bị bỏ qua nhất của việc dạy ngôn ngữ. Tồi tệ hơn, nhiều nhà phát triển hiểu sai, vấp phải một mớ hỗn độn của những sai lầm phổ biến cho đến khi họ đến một thứ gì đó ít nhất là hoạt động.structuring a Python project is one of the most often overlooked components of teaching the language. Worse, many developers get it wrong, stumbling through a jumble of common mistakes until they arrive at something that at least works.

Đây là tin tốt: Bạn không cần phải là một trong số họ!

Trong phần này của loạt phim Python đơn giản chết, chúng tôi sẽ khám phá các câu lệnh, mô -đun, gói, và cách ghép mọi thứ lại với nhau mà không xé tóc. Thậm chí chúng ta sẽ chạm vào VCS, PEP và Zen of Python. Thắt dây an toàn!

Thiết lập kho lưu trữ

Trước khi chúng tôi đi sâu vào cấu trúc dự án thực tế, hãy giải quyết cách thức điều này phù hợp với hệ thống kiểm soát phiên bản của chúng tôi [VCS] ... bắt đầu với thực tế bạn cần một VCS! Một vài lý do là ...

• Theo dõi mọi thay đổi bạn thực hiện,
• Tìm ra chính xác khi bạn phá vỡ một cái gì đó,
• Có thể xem các phiên bản cũ của mã của bạn,
• Sao lưu mã của bạn và
• Hợp tác với người khác.

Bạn đã có rất nhiều tùy chọn có sẵn cho bạn. Git là rõ ràng nhất, đặc biệt nếu bạn không biết nên sử dụng những gì khác. Bạn có thể lưu trữ kho Git của mình miễn phí trên GitHub, Gitlab, Bitbucket hoặc Gitote, trong số những người khác. Nếu bạn muốn một cái gì đó khác ngoài Git, có hàng tá các lựa chọn khác, bao gồm Mercurial, Bazaar, Subversion (mặc dù nếu bạn sử dụng cái cuối cùng đó, có lẽ bạn sẽ được coi là một con khủng long của bạn bè.)Git is the most obvious, especially if you don't know what else to use. You can host your Git repository for free on GitHub, GitLab, Bitbucket, or Gitote, among others. If you want something other than Git, there's dozens of other options, including Mercurial, Bazaar, Subversion (although if you use that last one, you'll probably be considered something of a dinosaur by your peers.)

Tôi sẽ lặng lẽ giả định rằng bạn đang sử dụng Git cho phần còn lại của hướng dẫn này, vì đó là những gì tôi sử dụng độc quyền.

Khi bạn đã tạo kho lưu trữ của mình và sao chép một bản sao cục bộ vào máy tính của bạn, bạn có thể bắt đầu thiết lập dự án của mình. Tối thiểu, bạn sẽ cần phải tạo như sau:

• import re
  

  6: Một mô tả về dự án của bạn và các mục tiêu của nó.

• import re
  

  7: Giấy phép dự án của bạn, nếu đó là nguồn mở. (Xem OpenSource.org để biết thêm thông tin về việc chọn một.)

• import re
  

  8: Một tệp đặc biệt cho Git biết các tệp và thư mục nào sẽ bỏ qua. (Nếu bạn đang sử dụng VCS khác, tệp này có một tên khác. Hãy tìm nó.)
• Một thư mục với tên của dự án của bạn.

Đúng vậy ... Các tệp mã Python của chúng tôi thực sự thuộc về một thư mục con riêng biệt! Điều này rất quan trọng, vì thư mục gốc của kho lưu trữ của chúng tôi sẽ trở nên lộn xộn với các tệp xây dựng, tập lệnh đóng gói, môi trường ảo và tất cả các cách khác không thực sự là một phần của mã nguồn.our Python code files actually belong in a separate subdirectory! This is very important, as our repository's root directory is going to get mighty cluttered with build files, packaging scripts, virtual environments, and all manner of other things that aren't actually part of the source code.

Chỉ vì lợi ích của ví dụ, chúng tôi sẽ gọi dự án hư cấu của chúng tôi

import re

Pep 8 và đặt tên

Phong cách Python được điều chỉnh phần lớn bởi một tập hợp các tài liệu được gọi là đề xuất tăng cường Python, viết tắt PEP. Tất nhiên, không phải tất cả các PEP đều được thông qua - đó là lý do tại sao chúng được gọi là "đề xuất" - nhưng một số là. Bạn có thể duyệt chỉ số PEP chính trên trang web Python chính thức. Chỉ số này được chính thức gọi là PEP 0.Python Enhancement Proposals, abbreviated PEP. Not all PEPs are actually adopted, of course - that's why they're called "Proposals" - but some are. You can browse the master PEP index on the official Python website. This index is formally referred to as PEP 0.

Ngay bây giờ, chúng tôi chủ yếu quan tâm đến PEP 8, lần đầu tiên được tác giả bởi người tạo ngôn ngữ Python Guido Van Rossum trở lại vào năm 2001. Đây là tài liệu chính thức phác thảo phong cách mã hóa mà tất cả các nhà phát triển Python thường nên tuân theo. Giữ nó dưới gối của bạn! Tìm hiểu nó, làm theo nó, khuyến khích người khác làm như vậy.PEP 8, first authored by the Python language creator Guido van Rossum back in 2001. It is the document which officially outlines the coding style all Python developers should generally follow. Keep it under your pillow! Learn it, follow it, encourage others to do the same.

.

Ngay bây giờ, chúng tôi chủ yếu quan tâm đến phần có tên "Gói và tên mô -đun" ... ...

Các mô-đun nên có tên ngắn, toàn bộ. Dấu gạch dưới có thể được sử dụng trong tên mô -đun nếu nó cải thiện khả năng đọc. Các gói Python cũng nên có tên ngắn, toàn bộ, mặc dù việc sử dụng dấu gạch dưới không được khuyến khích.

Chúng ta sẽ nhận được chính xác các mô -đun và gói trong một khoảnh khắc, nhưng bây giờ, hãy hiểu rằng các mô -đun được đặt tên bởi tên tệp và các gói được đặt tên theo tên thư mục của chúng.modules are named by filenames, and packages are named by their directory name.

Nói cách khác, tên tệp nên là chữ thường, với dấu gạch dưới nếu điều đó cải thiện khả năng đọc. Tương tự, tên thư mục phải là tất cả các chữ thường, mà không nhấn mạnh nếu có thể tránh được. Để đặt theo cách khác ...filenames should be all lowercase, with underscores if that improves readability. Similarly, directory names should be all lowercase, without underscores if at all avoidable. To put that another way...

• Làm điều này:

  # smart_door.py
  def close():
      print("Ahhhhhhhhhhhh.")
  
  def open():
      print("Thank you for making a simple door very happy.")
  

  0
• Không phải thế này:

  # smart_door.py
  def close():
      print("Ahhhhhhhhhhhh.")
  
  def open():
      print("Thank you for making a simple door very happy.")
  

  1

Tôi biết, tôi biết, cách dài để tạo ra một điểm, nhưng ít nhất tôi đã đặt một chút pep trong bước của bạn. (Xin chào? Đây có phải là thứ trên không?)

Gói và mô -đun

Điều này sẽ cảm thấy chống vi khuẩn, nhưng đây là những định nghĩa được hứa hẹn:

Bất kỳ tệp Python (

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Chà ... gần như. Có một điều khác bạn phải làm cho một thư mục để biến nó thành một gói và đó là để một tệp có tên

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Có những thứ thú vị khác bạn có thể làm với

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Nếu bạn quên

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Vì vậy, nếu chúng ta nhìn vào cấu trúc dự án của mình,

import re

import re

Chúng ta hãy xem một ảnh chụp nhanh các dự án trong thế giới thực của tôi,

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

Nhập chế độ FullScreenen EXIT Mode FullScreen

(Trong trường hợp bạn đang tự hỏi, tôi đã sử dụng chương trình UNIX

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Bạn sẽ thấy rằng tôi có một gói cấp cao nhất được gọi là

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Tôi cũng có một tệp đặc biệt khác trong gói cấp cao nhất của mình:

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

Nhập hoạt động như thế nào

Nếu bạn đã viết bất kỳ mã Python có ý nghĩa nào trước đây, bạn gần như chắc chắn đã quen thuộc với câu lệnh

import re

import re

Nhập chế độ FullScreenen EXIT Mode FullScreen

(Trong trường hợp bạn đang tự hỏi, tôi đã sử dụng chương trình UNIX

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Bạn sẽ thấy rằng tôi có một gói cấp cao nhất được gọi là

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Tôi cũng có một tệp đặc biệt khác trong gói cấp cao nhất của mình:

import smart_door
smart_door.open()
smart_door.close()

8. Đây là tệp được chạy khi chúng tôi thực hiện trực tiếp gói cấp cao nhất của chúng tôi thông qua

import smart_door
smart_door.open()
smart_door.close()

9. Chúng ta sẽ nói về những gì diễn ra trong đó

import smart_door
smart_door.open()
smart_door.close()

8 một chút.
File "weird.py", line 1, in
import re
File "re.py", line 122, in
import enum
ModuleNotFoundError: No module named 'enum'

Nhập hoạt động như thế nào

Nếu bạn đã viết bất kỳ mã Python có ý nghĩa nào trước đây, bạn gần như chắc chắn đã quen thuộc với câu lệnh

import re

Thật hữu ích khi biết rằng, khi chúng tôi nhập một mô -đun, chúng tôi thực sự đang chạy nó. Điều này có nghĩa là bất kỳ câu lệnh import re 5 nào trong mô -đun cũng đang được chạy.

Ví dụ,

from smart_door import open
open()

from smart_door import open
open()

from smart_door import open
open()

from smart_door import open
open()

from smart_door import open
open()

Traceback (cuộc gọi gần đây nhất cuối cùng): Tệp "WEIRD.PY", LINE 1, trong tệp nhập RE "Re.py", dòng 122, trong nhập enum modulenotfounderror: Không có mô -đun có tên 'enum'

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Nhập chế độ FullScreenen EXIT Mode FullScreen

(Trong trường hợp bạn đang tự hỏi, tôi đã sử dụng chương trình UNIX

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Bạn sẽ thấy rằng tôi có một gói cấp cao nhất được gọi là

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

Nhập chế độ FullScreenen EXIT Mode FullScreen

(Trong trường hợp bạn đang tự hỏi, tôi đã sử dụng chương trình UNIX

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

from smart_door import open, close
open()
close()

from smart_door import *

Bạn sẽ thấy rằng tôi có một gói cấp cao nhất được gọi là

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Tôi cũng có một tệp đặc biệt khác trong gói cấp cao nhất của mình:

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

import smart_door
smart_door.open()
smart_door.close()

Nhập hoạt động như thế nào

Nếu bạn đã viết bất kỳ mã Python có ý nghĩa nào trước đây, bạn gần như chắc chắn đã quen thuộc với câu lệnh

import re

Thật hữu ích khi biết rằng, khi chúng tôi nhập một mô -đun, chúng tôi thực sự đang chạy nó. Điều này có nghĩa là bất kỳ câu lệnh

import re

from smart_door import open
open()

Nhập chế độ FullScreenen EXIT Mode FullScreen

(Trong trường hợp bạn đang tự hỏi, tôi đã sử dụng chương trình UNIX

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

from smart_door import open, close
open()
close()

Nhập chế độ FullScreenen EXIT Mode FullScreen

Trong cơn ác mộng đóng gói lồng nhau khủng khiếp đó trước đó, giờ đây chúng ta có thể nói

from smart_door import *

from smart_door import *

from smart_door import *

from smart_door import *

Hệ thống

import re

Tuy nhiên, không lâu, có lẽ bạn sẽ thấy mình nói "nhưng tôi có hàng trăm chức năng trong mô -đun của mình và tôi muốn sử dụng tất cả!" Đây là điểm mà nhiều nhà phát triển đi ra khỏi đường ray, bằng cách làm điều này ...

from smart_door import *

Nhập chế độ FullScreenen EXIT Mode FullScreen

Điều này rất, rất xấu! Nói một cách đơn giản, nó nhập mọi thứ trong mô -đun trực tiếp và đó là một vấn đề. Hãy tưởng tượng mã sau ... Simply put, it imports everything in the module directly, and that's a problem. Imagine the following code...

from smart_door import *
from gzip import *
open()

Nhập chế độ FullScreenen EXIT Mode FullScreen

Bạn cho rằng điều gì sẽ xảy ra? Câu trả lời là,

from smart_door import *
from gzip import *
open()

from smart_door import open, close
open()
close()

from smart_door import *
from gzip import *
open()

from smart_door import open, close
open()
close()

from smart_door import open, close
open()
close()

Tất nhiên, vì chúng ta thường không biết, hoặc ít nhất là không nhớ, mọi hàm, lớp và biến trong mỗi mô -đun được nhập, chúng ta có thể dễ dàng kết thúc với rất nhiều mớ hỗn độn.

Zen of Python cũng đề cập đến kịch bản này ...

Rõ ràng là tốt hơn tiềm ẩn.

Bạn không bao giờ phải đoán nơi một chức năng hoặc biến đến từ đâu. Ở đâu đó trong tệp nên là mã rõ ràng cho chúng ta biết nó đến từ đâu. Hai kịch bản đầu tiên chứng minh điều đó.

Tôi cũng nên đề cập rằng kịch bản

from smart_door import *

Căn hộ tốt hơn so với lồng nhau.

Một số gói của các gói là ổn, nhưng khi dự án của bạn bắt đầu trông giống như một bộ búp bê Matryoshka phức tạp, bạn đã làm điều gì đó sai. Tổ chức các mô -đun của bạn thành các gói, nhưng giữ cho nó đơn giản hợp lý.

Nhập khẩu trong dự án của bạn

Cấu trúc tệp dự án mà chúng tôi đã tạo trước đó sắp trở nên rất tiện dụng. Nhớ lại dự án

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

Nhập chế độ FullScreenen EXIT Mode FullScreen

Trong mô -đun

from smart_door import *
from gzip import *
open()

from smart_door import *
from gzip import *
open()

from smart_door import *
from gzip import *
open()

from smart_door import *
from gzip import *
open()

Bởi vì tôi đã xác định

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

from omission.common.game_enums import GameMode

Nhập chế độ FullScreenen EXIT Mode FullScreen

Điều này được gọi là nhập khẩu tuyệt đối. Nó bắt đầu ở gói cấp cao nhất,

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

Một số nhà phát triển đến với tôi với các báo cáo nhập khẩu giống như

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

import smart_door
smart_door.open()
smart_door.close()

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

Nó, tuy nhiên, biết về cha mẹ của nó. Bởi vì điều này, Python có một thứ gọi là nhập khẩu tương đối cho phép chúng ta làm điều tương tự như thế này thay vào đó ...relative imports that lets us do the same thing like this instead...

import re

Nhập chế độ FullScreenen EXIT Mode FullScreen

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

Có rất nhiều cuộc tranh luận về việc sử dụng nhập khẩu tuyệt đối hay tương đối. Cá nhân, tôi thích sử dụng nhập khẩu tuyệt đối bất cứ khi nào có thể, bởi vì nó làm cho mã dễ đọc hơn rất nhiều. Bạn có thể tạo nên tâm trí của riêng bạn, tuy nhiên. Phần quan trọng duy nhất là kết quả là rõ ràng - không nên có bí ẩn nào đến từ đâu.

(Tiếp tục đọc: Real Python - Tuyệt đối với nhập khẩu tương đối

Có một gotcha ẩn nấp khác ở đây! Trong

from omission.common.game_enums import GameMode

import re

Nhập chế độ FullScreenen EXIT Mode FullScreen

Chắc chắn, vì cả hai mô -đun này đều nằm trong cùng một gói, chúng ta sẽ có thể nói

from omission.common.game_enums import GameMode

Sai! Nó thực sự sẽ thất bại trong việc định vị

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Tuy nhiên, chúng tôi có thể sử dụng nhập khẩu tương đối thay thế:

import re

Nhập chế độ FullScreenen EXIT Mode FullScreen

Trong trường hợp đó,

from omission.common.game_enums import GameMode

Nếu bạn quen thuộc với hệ thống tệp Unix điển hình, điều này sẽ bắt đầu có ý nghĩa.

omission-git
├── LICENSE.md
├── omission
│   ├── app.py
│   ├── common
│   │   ├── classproperty.py
│   │   ├── constants.py
│   │   ├── game_enums.py
│   │   └── __init__.py
│   ├── data
│   │   ├── data_loader.py
│   │   ├── game_round_settings.py
│   │   ├── __init__.py
│   │   ├── scoreboard.py
│   │   └── settings.py
│   ├── game
│   │   ├── content_loader.py
│   │   ├── game_item.py
│   │   ├── game_round.py
│   │   ├── __init__.py
│   │   └── timer.py
│   ├── __init__.py
│   ├── __main__.py
│   ├── resources
│   └── tests
│       ├── __init__.py
│       ├── test_game_item.py
│       ├── test_game_round_settings.py
│       ├── test_scoreboard.py
│       ├── test_settings.py
│       ├── test_test.py
│       └── test_timer.py
├── pylintrc
├── README.md
└── .gitignore

from omission.common.game_enums import GameMode

from omission.common.game_enums import GameMode

import re

Tuy nhiên, hãy nhớ rằng những "cấp độ" đó không chỉ là các thư mục đơn giản, ở đây. Chúng là các gói. Nếu bạn có hai gói riêng biệt trong một thư mục đơn giản không phải là gói, bạn không thể sử dụng nhập khẩu tương đối để nhảy từ cái này sang thư mục khác. Bạn sẽ phải làm việc với đường dẫn tìm kiếm Python cho điều đó và điều đó nằm ngoài phạm vi của hướng dẫn này. (Xem các tài liệu ở cuối bài viết này.)

import smart_door smart_door.open() smart_door.close() 8

Bạn có nhớ khi tôi đề cập đến việc tạo

import smart_door
smart_door.open()
smart_door.close()

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

import smart_door
smart_door.open()
smart_door.close()

Đây là nội dung của tệp đó:

import re

Nhập chế độ FullScreenen EXIT Mode FullScreen

Đúng, đó thực sự là nó! Tôi đang nhập mô-đun của mình

import re

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Hãy nhớ rằng, tôi cũng có thể đã nói

import re

import re

import re

import re

import re

.

Phần gây nhầm lẫn hầu hết mọi người lúc đầu là toàn bộ tuyên bố

import re

import re

import re

from omission.common.game_enums import GameMode

Khi một mô -đun được chạy trực tiếp qua

import re

import re

Do đó,

import re

Bạn có thể thấy điều này trong hành động một cách khác. Nếu tôi thêm phần sau vào cuối ____ 112 ...

import re

Nhập chế độ FullScreenen EXIT Mode FullScreen

Đúng, đó thực sự là nó! Tôi đang nhập mô-đun của mình

import re

# smart_door.py
def close():
    print("Ahhhhhhhhhhhh.")

def open():
    print("Thank you for making a simple door very happy.")

Hãy nhớ rằng, tôi cũng có thể đã nói

import re

import re

import re

import re

import re

.

Phần gây nhầm lẫn hầu hết mọi người lúc đầu là toàn bộ tuyên bố import re 14. Python không có nhiều nồi hơi - mã phải được sử dụng khá phổ biến với rất ít hoặc không có sửa đổi - nhưng đây là một trong những bit hiếm.

import re

import re

from omission.common.game_enums import GameMode

• Khi một mô -đun được chạy trực tiếp qua

  import re
  

  18, mô -đun đó được gán giá trị đặc biệt là

  import re
  

  15: "Chính".

• Do đó,

  import re
  

  20 thực sự đang kiểm tra xem mô -đun có được thực thi làm mô -đun chính không. Nếu có, nó chạy mã theo điều kiện.module.

• Bạn có thể thấy điều này trong hành động một cách khác. Nếu tôi thêm phần sau vào cuối ____ 112 ...packages. Each package must contain a special

  # smart_door.py
  def close():
      print("Ahhhhhhhhhhhh.")
  
  def open():
      print("Thank you for making a simple door very happy.")
  

  3 file.

• ... Sau đó tôi có thể thực thi mô -đun đó trực tiếp qua

  import re
  

  22 và kết quả giống như

  import smart_door
  smart_door.open()
  smart_door.close()
  

  9. Bây giờ

  import smart_door
  smart_door.open()
  smart_door.close()
  

  8 đang bị bỏ qua hoàn toàn và ____115 của

  import re
  

  26 là

  import re
  

  27.

• Trong khi đó, nếu tôi chỉ chạy

  import smart_door
  smart_door.open()
  smart_door.close()
  

  9, mã đặc biệt đó trong

  import re
  

  12 bị bỏ qua, vì

  import re
  

  15 của nó hiện là

  import re
  

  31 một lần nữa. use

  import re
  

  34 in an import statement. Before you entertain a possible exception, the Zen of Python points out "Special cases aren't special enough to break the rules."

• Xem cách hoạt động của nó?

• Gói lên

Hãy xem xét.

• Mỗi dự án nên sử dụng VCS, chẳng hạn như Git. Có rất nhiều lựa chọn để lựa chọn.
• Mỗi tệp mã Python (

  # smart_door.py
  def close():
      print("Ahhhhhhhhhhhh.")
  
  def open():
      print("Thank you for making a simple door very happy.")
  

  2) là một mô -đun.
• Tổ chức các mô -đun của bạn thành các gói. Mỗi gói phải chứa một tệp

  # smart_door.py
  def close():
      print("Ahhhhhhhhhhhh.")
  
  def open():
      print("Thank you for making a simple door very happy.")
  

  3 đặc biệt.
• Dự án của bạn thường bao gồm một gói cấp cao nhất, thường chứa các gói phụ. Gói cấp cao nhất đó thường chia sẻ tên của dự án của bạn và tồn tại dưới dạng thư mục trong gốc của kho lưu trữ dự án của bạn.
• Không bao giờ sử dụng

  import re
  

  34 trong một tuyên bố nhập khẩu. Trước khi bạn giải trí một ngoại lệ có thể, Zen of Python chỉ ra "các trường hợp đặc biệt không đủ đặc biệt để phá vỡ các quy tắc".

Sử dụng nhập khẩu tuyệt đối hoặc tương đối để chỉ các mô -đun khác trong dự án của bạn.

Chương trình Python được cấu trúc như thế nào?

Cách tốt nhất để tổ chức mã Python là gì?

Các dự án Python được đặt tên như thế nào?

Các loại dự án trong Python là gì?