Hướng dẫn python argparse if __name__ == __main__ - python argparse nếu __name__ == __main__

Tóm lại: nó cho phép bạn thực thi mã khi tệp chạy dưới dạng tập lệnh, nhưng không phải khi nó được nhập dưới dạng mô -đun

Đối với hầu hết các mục đích thực tế, bạn có thể nghĩ về khối có điều kiện mà bạn mở bằng

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Bạn sẽ thấy điều đó có nghĩa là gì trong một khoảnh khắc. Hiện tại, giả sử bạn có tệp sau:

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Trong ví dụ này, bạn xác định một hàm,

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

Dưới đó, trong các dòng 10 đến 12, bạn sử dụng thành ngữ

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

Khi bạn chạy tệp dưới dạng tập lệnh bằng cách chuyển đối tượng tệp cho trình thông dịch python của bạn, biểu thức

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

Hãy tự mình thử nó! Bạn có thể tải xuống tất cả các tệp mã mà bạn sẽ sử dụng trong hướng dẫn này từ liên kết bên dưới:

Đồng thời, nếu bạn nhập

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

>>>

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

Trong trường hợp này, bạn muốn sử dụng

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

Khi bạn làm tổ mã cụ thể cho việc sử dụng tập lệnh của tập tin của bạn theo thành ngữ

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Mã làm tổ theo

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

• Tập lệnh: Khi chạy dưới dạng tập lệnh, mã của bạn sẽ nhắc người dùng để nhập, gọi

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  0 và in kết quả. When run as a script, your code prompts the user for input, calls

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  0, and prints the result.
• Mô -đun: Khi bạn nhập

  >>> from echo import echo
  >>> print(echo("Please help me I'm stuck on a mountain"))
  ain
  in
  n
  .
  

  2 dưới dạng mô -đun, thì

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  0 sẽ được xác định, nhưng không có mã thực thi. Bạn cung cấp

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  0 cho phiên mã chính mà không có bất kỳ tác dụng phụ nào. When you import

  >>> from echo import echo
  >>> print(echo("Please help me I'm stuck on a mountain"))
  ain
  in
  n
  .
  

  2 as a module, then

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  0 gets defined, but no code executes. You provide

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  0 to the main code session without any side effects.

Bằng cách triển khai thành ngữ

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

Có bạn đi! Bây giờ bạn đã đề cập đến thông tin quan trọng nhất về chủ đề này. Tuy nhiên, có nhiều hơn nữa để tìm hiểu, và có một số sự tinh tế có thể giúp bạn xây dựng sự hiểu biết sâu sắc hơn về mã này và Python nói chung.

Đọc để tìm hiểu thêm về thành ngữ tên chính, vì hướng dẫn này sẽ nói ngắn gọn về nó.

Làm thế nào để thành ngữ tên chính hoạt động?

Tại cốt lõi của nó, thành ngữ là một câu lệnh có điều kiện kiểm tra xem giá trị của biến

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

• Nếu biểu thức

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  5 là

   1# echo.py
   2
   3def echo(text: str, repetitions: int = 3) -> str:
   4    """Imitate a real-world echo."""
   5    echoed_text = ""
   6    for i in range(repetitions, 0, -1):
   7        echoed_text += f"{text[-i:]}\n"
   8    return f"{echoed_text.lower()}."
   9
  10if __name__ == "__main__":
  11    text = input("Yell something at a mountain: ")
  12    print(echo(text))
  

  5, thì mã được thụt vào sau câu lệnh có điều kiện sẽ thực thi.
• Nếu biểu thức

  $ python echo.py
  Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
  ooo
  oo
  o
  .
  

  5 là

  # namemain.py
  
  print(__name__, type(__name__))
  

  6, thì Python bỏ qua mã thụt lề.

Nhưng khi nào

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

Python đặt toàn cầu

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

Mã cấp cao nhất là mô-đun Python do người dùng chỉ định đầu tiên bắt đầu chạy. Nó có giá trị cấp cao nhất vì nó nhập tất cả các mô-đun khác mà chương trình cần. (Nguồn)

Để hiểu rõ hơn điều đó có nghĩa là gì, bạn sẽ thiết lập một ví dụ nhỏ thực tế. Tạo tệp Python, gọi nó là

$ python namemain.py
__main__ <class 'str'>

# namemain.py

print(__name__, type(__name__))

Tệp mới của bạn chỉ chứa một dòng mã duy nhất in giá trị và loại của toàn cầu

# namemain.py

print(__name__, type(__name__))

Quay đầu thiết bị đầu cuối của bạn và chạy tệp Python dưới dạng tập lệnh:

$ python namemain.py
__main__ <class 'str'>

Đầu ra cho bạn thấy rằng giá trị của

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

Bây giờ bạn đã biết giá trị của

# namemain.py

print(__name__, type(__name__))

Nhưng một tuyên bố có điều kiện chỉ có thể tạo ra kết quả khác nhau khi điều kiện có cơ hội đánh giá theo những cách khác nhau. Vì vậy, khi nào mã của bạn không chạy trong môi trường mã cấp cao nhất và điều gì xảy ra với giá trị của

# namemain.py

print(__name__, type(__name__))

Mã trong tệp của bạn không được chạy trong môi trường mã cấp cao hơn nếu bạn nhập mô-đun của mình. Trong trường hợp đó, Python đặt

# namemain.py

print(__name__, type(__name__))

Để thử điều này, hãy khởi động bảng điều khiển Python và nhập mã từ

$ python namemain.py
__main__ <class 'str'>

>>>

>>> import namemain
namemain <class 'str'>

Trong trường hợp này, bạn muốn sử dụng

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

Khi bạn làm tổ mã cụ thể cho việc sử dụng tập lệnh của tập tin của bạn theo thành ngữ

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Bạn chỉ biết rằng đối với môi trường mã cấp cao nhất của bạn,

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

>>> import namemain
namemain <class 'str'>

>>>

>>> __name__
'__main__'

>>> namemain.__name__
'namemain'

Toàn cầu

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

>>> import namemain
namemain <class 'str'>

>>> import namemain
namemain <class 'str'>

>>> import namemain
namemain <class 'str'>

Bây giờ bạn biết rằng giá trị của

# namemain.py

print(__name__, type(__name__))

• Trong môi trường mã cấp cao nhất, giá trị của

  # namemain.py
  
  print(__name__, type(__name__))
  

  1 là

  # namemain.py
  
  print(__name__, type(__name__))
  

  2.the top-level code environment, the value of

  # namemain.py
  
  print(__name__, type(__name__))
  

  1 is

  # namemain.py
  
  print(__name__, type(__name__))
  

  2.
• Trong một mô -đun đã nhập, giá trị của

  # namemain.py
  
  print(__name__, type(__name__))
  

  1 là tên mô -đun dưới dạng chuỗi.imported module, the value of

  # namemain.py
  
  print(__name__, type(__name__))
  

  1 is the module’s name as a string.

Bởi vì Python tuân theo các quy tắc này, bạn có thể tìm hiểu xem một mô-đun có chạy trong môi trường mã cấp cao nhất hay không. Bạn làm điều này bằng cách kiểm tra giá trị của

# namemain.py

print(__name__, type(__name__))

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Với việc kiểm tra có điều kiện này, bạn có thể khai báo mã chỉ thực thi khi mô-đun được chạy trong môi trường mã cấp cao nhất.

Thêm thành ngữ vào

$ python namemain.py
__main__ <class 'str'>

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Khi chạy mã của bạn dưới dạng tập lệnh, cả hai gọi đến

>>> __name__
'__main__'

>>> namemain.__name__
'namemain'

Tiếp theo, hãy bắt đầu một phiên phiên dịch mới và nhập

>>> import namemain
namemain <class 'str'>

>>>

>>> import namemain
namemain <class 'str'>

Toàn cầu

# namemain.py

print(__name__, type(__name__))

# namemain.py

print(__name__, type(__name__))

>>> import namemain
namemain <class 'str'>

>>> import namemain
namemain <class 'str'>

>>> import namemain
namemain <class 'str'>

Bây giờ bạn biết rằng giá trị của

# namemain.py

print(__name__, type(__name__))

Trong môi trường mã cấp cao nhất, giá trị của # namemain.py print(__name__, type(__name__)) 1 là # namemain.py print(__name__, type(__name__)) 2.

Trong một mô -đun đã nhập, giá trị của

# namemain.py

print(__name__, type(__name__))

Bởi vì Python tuân theo các quy tắc này, bạn có thể tìm hiểu xem một mô-đun có chạy trong môi trường mã cấp cao nhất hay không. Bạn làm điều này bằng cách kiểm tra giá trị của

# namemain.py

print(__name__, type(__name__))

Với việc kiểm tra có điều kiện này, bạn có thể khai báo mã chỉ thực thi khi mô-đun được chạy trong môi trường mã cấp cao nhất.

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Thêm thành ngữ vào

$ python namemain.py
__main__ <class 'str'>

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Khi chạy mã của bạn dưới dạng tập lệnh, cả hai gọi đến

>>> __name__
'__main__'

>>> namemain.__name__
'namemain'

Tiếp theo, hãy bắt đầu một phiên phiên dịch mới và nhập

>>> import namemain
namemain <class 'str'>

Khi bạn nhập tệp của mình dưới dạng mô -đun, mã mà bạn lồng vào

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Bây giờ bạn đã biết cách thức thành ngữ tên chính trong Python, bạn có thể tự hỏi khi nào và chính xác bạn nên sử dụng nó trong mã của mình và khi nào nên tránh nó!

Khi nào bạn nên sử dụng thành ngữ tên chính trong Python?

Bạn sử dụng thành ngữ này khi bạn muốn tạo một điểm nhập bổ sung cho tập lệnh của mình, để tệp của bạn có thể truy cập dưới dạng tập lệnh độc lập cũng như một mô-đun có thể nhập. Bạn có thể muốn điều đó khi tập lệnh của bạn cần thu thập đầu vào của người dùng.

Trong phần đầu tiên của hướng dẫn này, bạn đã sử dụng thành ngữ tên chính cùng với >>> from echo import echo >>> print(echo("Please help me I'm stuck on a mountain")) ain in n . 1 để thu thập đầu vào của người dùng khi chạy $ python echo.py Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO ooo oo o . 4 dưới dạng tập lệnh. Đó là một lý do tuyệt vời để sử dụng thành ngữ tên chính!

Ngoài ra còn có các cách khác để thu thập đầu vào người dùng trực tiếp từ dòng lệnh. Ví dụ: bạn có thể tạo một điểm nhập dòng lệnh cho một tập lệnh Python nhỏ với

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Thay vì thu thập đầu vào của người dùng với

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Python thu thập một số từ tùy ý vào

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Bằng cách thực hiện mã xử lý đầu vào của người dùng và làm tổ trong tên thành ngữ tên chính, bạn cung cấp một điểm nhập bổ sung cho tập lệnh của bạn.

Nếu bạn muốn tạo một điểm nhập cảnh cho một gói, thì bạn nên tạo một tệp

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

>>>

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Khi bạn tạo môi trường ảo bằng mô -đun

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Mặc dù điều này hoạt động cho các tệp nhỏ, nhưng nó thường không được coi là thực hành tốt. Nó không nên trộn các bài kiểm tra và mã trong cùng một tệp. Thay vào đó, hãy viết các bài kiểm tra của bạn trong một tệp riêng biệt. Theo lời khuyên này thường làm cho một cơ sở mã có tổ chức hơn. Cách tiếp cận này cũng loại bỏ bất kỳ chi phí nào, chẳng hạn như nhu cầu nhập

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Một lý do khác mà một số lập trình viên sử dụng thành ngữ tên chính là bao gồm một minh chứng cho những gì mã của họ có thể làm:demonstration of what their code can do:

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Một lần nữa, người dùng của bạn vẫn có thể nhập mô -đun mà không có bất kỳ tác dụng phụ nào. Ngoài ra, khi họ chạy

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

Bạn có thể tìm thấy các thực thi mã demo như vậy trong tên thành ngữ tên chính, nhưng có những cách tốt hơn được cho là để chứng minh cách sử dụng chương trình của bạn. Bạn có thể viết các tài liệu chi tiết với các lần chạy ví dụ có thể tăng gấp đôi dưới dạng tài liệu và bạn có thể soạn thảo tài liệu phù hợp cho dự án của mình.

Hai ví dụ trước đây bao gồm hai trường hợp sử dụng dưới mức tối ưu phổ biến của thành ngữ tên chính. Ngoài ra còn có các kịch bản khác khi nó tốt nhất để tránh thành ngữ chính trong Python:

• Một tập lệnh thuần túy: Nếu bạn viết một tập lệnh mà Lừa có nghĩa là được chạy dưới dạng tập lệnh, thì bạn có thể đặt quá trình thực thi mã của mình vào không gian tên toàn cầu mà không cần làm tổ trong tên thành ngữ tên chính. Bạn có thể sử dụng Python làm ngôn ngữ kịch bản vì nó không thực thi các mẫu hướng đối tượng mạnh mẽ. Bạn không cần phải gắn bó với các mẫu thiết kế từ các ngôn ngữ khác khi bạn lập trình bằng Python. If you write a script that’s meant to be run as a script, then you can put your code execution into the global namespace without nesting it in the name-main idiom. You can use Python as a scripting language because it doesn’t enforce strong object-oriented patterns. You don’t have to stick to design patterns from other languages when you program in Python.

• Một chương trình dòng lệnh phức tạp: Nếu bạn viết một ứng dụng dòng lệnh lớn hơn, thì tốt nhất là tạo một tệp riêng làm điểm nhập của bạn. Sau đó, bạn nhập mã từ mô-đun của mình ở đó thay vì xử lý đầu vào của người dùng với thành ngữ tên chính. Đối với các chương trình dòng lệnh phức tạp hơn, bạn cũng sẽ được hưởng lợi từ việc sử dụng mô-đun

   1if __name__ == "__main__":
   2    ...
  

  8 tích hợp thay vì

  import argparse
  
  # other code. . .
  
  def main(name):
      print('Hello, %s!' % name)
  
  if __name__ == '__main__':
      parser = argparse.ArgumentParser(description = 'Say hello')
      parser.add_argument('name', help='your name, enter it')
      args = parser.parse_args()
  
      main(args.name)
  

  02. If you write a larger command-line application, then it’s best to create a separate file as your entry point. You then import the code from your module there instead of handling user input with the name-main idiom. For more complex command-line programs, you’ll also benefit from using the built-in

   1if __name__ == "__main__":
   2    ...
  

  8 module instead of

  import argparse
  
  # other code. . .
  
  def main(name):
      print('Hello, %s!' % name)
  
  if __name__ == '__main__':
      parser = argparse.ArgumentParser(description = 'Say hello')
      parser.add_argument('name', help='your name, enter it')
      args = parser.parse_args()
  
      main(args.name)
  

  02.

Có lẽ bạn đã sử dụng thành ngữ chính tên cho một trong những mục đích dưới mức tối ưu này trước đây. Nếu bạn muốn tìm hiểu thêm về cách viết thêm Python thành ngữ cho từng kịch bản này, thì hãy làm theo các liên kết được cung cấp:

Mặc dù bây giờ bạn biết khi nào nên tránh thành ngữ chính tên, bạn vẫn có thể tự hỏi về cách sử dụng tốt nhất trong một kịch bản hợp lệ.

Theo cách nào bạn nên bao gồm thành ngữ tên chính?

Thành ngữ tên chính trong Python chỉ là một tuyên bố có điều kiện, vì vậy bạn có thể sử dụng nó ở bất cứ đâu trong tập tin của bạn ngay cả hơn một lần! Tuy nhiên, đối với hầu hết các trường hợp sử dụng, bạn sẽ đặt một thành ngữ chính tên ở cuối tập lệnh của bạn:

 1if __name__ == "__main__":
 2    ...

Bạn đặt tên thành ngữ tên chính ở cuối tập lệnh của bạn vì điểm nhập cho tập lệnh Python luôn là đỉnh của tệp. Nếu bạn đặt thành ngữ tên chính ở cuối tệp của bạn, thì tất cả các chức năng và lớp của bạn sẽ được xác định trước khi Python đánh giá biểu thức có điều kiện.

Tuy nhiên, mặc dù nó không phổ biến khi sử dụng nhiều hơn một tên thành ngữ chính trong một kịch bản, nhưng có thể có một lý do để làm như vậy trong một số trường hợp. Tài liệu hướng dẫn kiểu Python, PEP 8, rõ ràng nơi đặt tất cả các báo cáo nhập của bạn:

Nhập khẩu luôn được đặt ở đầu tệp, ngay sau khi bất kỳ bình luận và tài liệu mô -đun nào, và trước khi mô -đun toàn cầu và hằng số. (Nguồn)

Đây là lý do tại sao bạn đã nhập

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

$ python echo.py
Yell something at a mountain: HELLOOOO ECHOOOOOOOOOO
ooo
oo
o
.

 1if __name__ == "__main__":
 2    ...

Tuy nhiên, bạn không cần phải nhập

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

Để giải quyết vấn đề này và vẫn gắn bó với các đề xuất phong cách được xác định trong PEP 8, bạn có thể sử dụng thành ngữ tên chính tên thứ hai. Bằng cách làm tổ việc nhập

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

 1if __name__ == "__main__":
 2    ...

Bạn đã lồng vào việc nhập

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

>>> from echo import echo
>>> print(echo("Please help me I'm stuck on a mountain"))
ain
in
n
.

Như bạn đã học trước đó trong hướng dẫn, có ít trường hợp sử dụng thành ngữ tên chính hơn bạn mong đợi. Đối với hầu hết các trường hợp sử dụng đó, việc đặt một trong những kiểm tra có điều kiện này ở cuối tập lệnh của bạn sẽ là lựa chọn tốt nhất của bạn.

Cuối cùng, bạn có thể tự hỏi mã nào sẽ đi vào khối mã có điều kiện. Tài liệu Python cung cấp hướng dẫn rõ ràng về việc sử dụng thành ngữ của thành ngữ tên chính trong vấn đề đó:

Đặt càng ít câu lệnh càng tốt trong khối bên dưới

import argparse

# other code. . .

def main(name):
    print('Hello, %s!' % name)

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description = 'Say hello')
    parser.add_argument('name', help='your name, enter it')
    args = parser.parse_args()

    main(args.name)

34 có thể cải thiện độ rõ và tính đúng của mã. (Nguồn)

Giữ mã dưới tên của bạn ở vị trí chính của bạn ở mức tối thiểu! Khi bạn bắt đầu đặt nhiều dòng mã lồng nhau theo thành ngữ tên chính, thì thay vào đó, bạn nên xác định hàm

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

 1if __name__ == "__main__":
 2    ...

Mẫu thiết kế này cung cấp cho bạn lợi thế rằng mã dưới tên thành ngữ tên chính là rõ ràng và súc tích. Ngoài ra, nó có thể gọi

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Trong phần này, bạn đã học được rằng có lẽ bạn nên viết tên thành ngữ tên chính ở cuối kịch bản của bạn.

Nếu bạn có nhiều dòng mã mà bạn có kế hoạch làm tổ theo

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Bây giờ bạn đã biết làm thế nào bạn có thể sử dụng thành ngữ tên chính, bạn có thể tự hỏi tại sao nó trông khó hiểu hơn mã Python khác mà bạn đã từng sử dụng.

Là mã Boilerplate thành ngữ nên được đơn giản hóa?

Nếu bạn đến từ một ngôn ngữ lập trình hướng đối tượng khác, bạn có thể nghĩ rằng thành ngữ chính tên của Python là một điểm nhập cảnh giống với các chức năng ____33 trong Java hoặc C, nhưng Clumsier:

Mặc dù chắc chắn hài hước và dễ hiểu, meme này là sai lệch vì nó ngụ ý rằng thành ngữ tên chính có thể so sánh với các hàm điểm nhập

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Tên của Python tên chính là đặc biệt. Nó chỉ là một kiểm tra có điều kiện. Lúc đầu, nó có thể trông khó hiểu, đặc biệt là khi bạn bắt đầu làm việc với Python và bạn đã từng sử dụng để cú pháp Slim và thanh lịch của Python. Rốt cuộc, thành ngữ tên chính bao gồm một biến số ít từ không gian tên toàn cầu và một chuỗi cũng có giá trị khó chịu.

Vì vậy, nó không phải là loại điểm vào mà chính đại diện trong các ngôn ngữ khác. Nhưng tại sao nó trông giống như nó? Bạn có thể đã sao chép và dán thành ngữ nhiều lần, hoặc thậm chí gõ nó ra, và tự hỏi tại sao Python không có cú pháp ngắn gọn hơn cho nó.

Nếu bạn duyệt các tài liệu lưu trữ của danh sách gửi thư Python-Ideas, PEPS đã từ chối và Diễn đàn thảo luận Python, thì bạn sẽ tìm thấy một số nỗ lực để thay đổi thành ngữ.

Nếu bạn đọc một số cuộc thảo luận này, thì bạn sẽ nhận thấy rằng nhiều Pythonistas dày dạn lập luận rằng thành ngữ đó là mật mã và không nên thay đổi. Họ đưa ra nhiều lý do:

• Nó ngắn: Hầu hết các thay đổi được đề xuất chỉ tiết kiệm hai dòng mã. Most suggested changes save only two lines of code.
• Nó có một trường hợp sử dụng hạn chế: Bạn chỉ nên sử dụng nó nếu bạn cần chạy một tệp cả dưới dạng mô -đun cũng như tập lệnh. Bạn không cần phải sử dụng nó rất thường xuyên. You should only use it if you need to run a file both as a module as well as a script. You shouldn’t need to use it very often.
• Nó phơi bày sự phức tạp: Các biến và chức năng của Dunder là một phần lớn của Python một khi bạn nhìn sâu hơn một chút. Điều đó có thể làm cho thành ngữ hiện tại trở thành một điểm nhập cảnh cho những người học gây ra sự tò mò và mang đến cho họ cái nhìn đầu tiên dưới mui xe của cú pháp Python. Dunder variables and function are a big part of Python once you peek a bit deeper. That can make the current idiom an entry point for learners that sparks curiosity and gives them a first look under the hood of Python’s syntax.
• Nó duy trì khả năng tương thích ngược: Tên thành ngữ tên chính là một tiêu chuẩn thực tế trong ngôn ngữ trong một thời gian dài, điều đó có nghĩa là việc thay đổi nó sẽ phá vỡ khả năng tương thích ngược. The name-main idiom has been a de facto standard in the language for a long time, which means that changing it would break backward compatibility.

Được rồi, vì vậy bạn đã bị mắc kẹt với

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Mở rộng phần dưới đây cho một chút bối cảnh và một vài gợi ý về cách bạn có thể nói về thành ngữ tên chính mà không vặn lưỡi hoặc thắt nút ngón tay của bạn:

Bạn có thể thảo luận về việc sử dụng thành ngữ tên chính tại một số điểm trong sự nghiệp Python của bạn. Nó có một biểu hiện dài để viết và thậm chí còn cồng kềnh hơn để nói to, vì vậy bạn cũng có thể tìm thấy một cách tốt để nói về nó.

Có nhiều cách khác nhau để đề cập đến nó trong cộng đồng Python. Hầu hết các đề cập trực tuyến bao gồm toàn bộ biểu thức

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

• Công ước

   1# echo.py
   2
   3def echo(text: str, repetitions: int = 3) -> str:
   4    """Imitate a real-world echo."""
   5    echoed_text = ""
   6    for i in range(repetitions, 0, -1):
   7        echoed_text += f"{text[-i:]}\n"
   8    return f"{echoed_text.lower()}."
   9
  10if __name__ == "__main__":
  11    text = input("Yell something at a mountain: ")
  12    print(echo(text))
  

  1 (Nguồn)
• Biểu thức

   1# echo.py
   2
   3def echo(text: str, repetitions: int = 3) -> str:
   4    """Imitate a real-world echo."""
   5    echoed_text = ""
   6    for i in range(repetitions, 0, -1):
   7        echoed_text += f"{text[-i:]}\n"
   8    return f"{echoed_text.lower()}."
   9
  10if __name__ == "__main__":
  11    text = input("Yell something at a mountain: ")
  12    print(echo(text))
  

  1 (Nguồn)
• Thành ngữ

  import argparse
  
  # other code. . .
  
  def main(name):
      print('Hello, %s!' % name)
  
  if __name__ == '__main__':
      parser = argparse.ArgumentParser(description = 'Say hello')
      parser.add_argument('name', help='your name, enter it')
      args = parser.parse_args()
  
      main(args.name)
  

  45 (Nguồn)
• Thành ngữ

  import argparse
  
  # other code. . .
  
  def main(name):
      print('Hello, %s!' % name)
  
  if __name__ == '__main__':
      parser = argparse.ArgumentParser(description = 'Say hello')
      parser.add_argument('name', help='your name, enter it')
      args = parser.parse_args()
  
      main(args.name)
  

  46 (Nguồn)
• Thành ngữ

   1# echo.py
   2
   3def echo(text: str, repetitions: int = 3) -> str:
   4    """Imitate a real-world echo."""
   5    echoed_text = ""
   6    for i in range(repetitions, 0, -1):
   7        echoed_text += f"{text[-i:]}\n"
   8    return f"{echoed_text.lower()}."
   9
  10if __name__ == "__main__":
  11    text = input("Yell something at a mountain: ")
  12    print(echo(text))
  

  1 (Nguồn)
• Khổ thơ thực thi (nguồn)

Như bạn có thể nhận thấy, không có quy ước nghiêm ngặt nào xung quanh cách nói về

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Nếu bạn muốn quảng bá tiêu chuẩn hóa một tên ngắn hơn cho thành ngữ, thì hãy nói với bạn bè của bạn gọi nó là thành ngữ tên chính. Đó là những gì chúng tôi sẽ gọi nó tại Real Python! Nếu bạn thấy thuật ngữ hữu ích, thì có lẽ nó sẽ bắt kịp.the name-main idiom. That’s what we’ll be calling it at Real Python! If you find the term useful, then maybe it’ll catch on.

Nếu bạn tò mò, hãy lao vào một số cuộc thảo luận được liên kết trong các kênh cộng đồng Python khác nhau để tìm hiểu thêm về lý do tại sao các nhà phát triển tranh luận về việc giữ tên thành ngữ tên chính như vậy.

Sự kết luận

Bạn đã học được những gì thành ngữ

 1# echo.py
 2
 3def echo(text: str, repetitions: int = 3) -> str:
 4    """Imitate a real-world echo."""
 5    echoed_text = ""
 6    for i in range(repetitions, 0, -1):
 7        echoed_text += f"{text[-i:]}\n"
 8    return f"{echoed_text.lower()}."
 9
10if __name__ == "__main__":
11    text = input("Yell something at a mountain: ")
12    print(echo(text))

Bạn cũng đã biết một số trường hợp sử dụng phổ biến nhưng dưới mức tối ưu và tìm hiểu về các phương pháp tốt hơn và thành ngữ hơn mà bạn có thể thực hiện trong các kịch bản đó.Có lẽ bạn đã chấp nhận thành ngữ chính tên của Python, sau khi tìm hiểu thêm về nó, nhưng nếu bạn vẫn không thích nó, thì thật tốt khi biết rằng bạn có thể thay thế việc sử dụng nó trong hầu hết các trường hợp.

Khi nào bạn sử dụng thành ngữ tên chính trong mã Python của bạn?Trong khi đọc hướng dẫn này, bạn đã khám phá ra một cách để thay thế nó, hoặc có một trường hợp sử dụng tốt mà chúng tôi đã bỏ lỡ?Chia sẻ suy nghĩ của bạn trong các ý kiến dưới đây.