คลาส“ ส่วนตัว” (การนำไปใช้งาน) ใน Python

ฉันกำลังเขียนโค้ดโมดูล Python ขนาดเล็กซึ่งประกอบด้วยสองส่วน:

• ฟังก์ชันบางอย่างที่กำหนดอินเทอร์เฟซสาธารณะ
• คลาสการใช้งานที่ใช้โดยฟังก์ชันข้างต้น แต่ไม่มีความหมายภายนอกโมดูล

ในตอนแรกฉันตัดสินใจที่จะ "ซ่อน" คลาสการนำไปใช้งานนี้โดยกำหนดไว้ในฟังก์ชันโดยใช้มัน แต่สิ่งนี้ขัดขวางความสามารถในการอ่านและไม่สามารถใช้ได้หากฟังก์ชันหลายฟังก์ชันใช้คลาสเดียวกันซ้ำ

ดังนั้นนอกจากความคิดเห็นและ docstrings แล้วยังมีกลไกในการทำเครื่องหมายชั้นเรียนเป็น "ส่วนตัว" หรือ "ภายใน" หรือไม่? ฉันทราบถึงกลไกขีดล่าง แต่ตามที่ฉันเข้าใจมันใช้กับตัวแปรฟังก์ชันและชื่อวิธีการเท่านั้น

ใช้คำนำหน้าขีดล่างเดียว:

class _Internal:
    ...

นี่คืออนุสัญญา Python อย่างเป็นทางการสำหรับสัญลักษณ์ 'ภายใน' "จากการนำเข้าโมดูล *" ไม่นำเข้าอ็อบเจ็กต์ที่มีเครื่องหมายขีดล่าง

แก้ไข: อ้างอิงถึงอนุสัญญาขีดล่างเดียว

ในระยะสั้น:

1. คุณไม่สามารถบังคับใช้ความเป็นส่วนตัวได้ ไม่มีคลาส / วิธีการ / ฟังก์ชันส่วนตัวใน Python อย่างน้อยความเป็นส่วนตัวไม่เข้มงวดเหมือนในภาษาอื่น ๆ เช่น Java

2. คุณสามารถระบุ / แนะนำความเป็นส่วนตัวเท่านั้น สิ่งนี้เป็นไปตามแบบแผน รูปแบบ Python สำหรับการทำเครื่องหมายคลาส / ฟังก์ชัน / วิธีการเป็นส่วนตัวคือการนำหน้าด้วย _ (ขีดล่าง) ตัวอย่างเช่นdef _myfunc()หรือclass _MyClass:. นอกจากนี้คุณยังสามารถสร้างความเป็นส่วนตัวหลอกได้โดยการใส่เครื่องหมายขีดล่าง__fooไว้ล่วงหน้า(เช่น:) คุณไม่สามารถเข้าถึงวิธีการโดยตรง แต่คุณยังสามารถเรียกมันผ่านคำนำหน้าพิเศษใช้ ClassName (เช่น: _classname__foo) ดังนั้นสิ่งที่ดีที่สุดที่คุณทำได้คือระบุ / แนะนำความเป็นส่วนตัวไม่ใช่บังคับใช้

Python เป็นเหมือน perl ในแง่นี้ ในการถอดความบรรทัดที่มีชื่อเสียงเกี่ยวกับความเป็นส่วนตัวจากหนังสือ Perl ปรัชญาคือคุณควรอยู่นอกห้องนั่งเล่นเพราะคุณไม่ได้รับเชิญไม่ใช่เพราะได้รับการปกป้องด้วยปืนลูกซอง

สำหรับข้อมูลเพิ่มเติม:

• เอกสาร Python ตัวแปรส่วนตัว
• เหตุใดเมธอด 'ส่วนตัว' ของ Python จึงไม่เป็นส่วนตัว? คำถาม StackOverflow 70528

กำหนด__all__รายชื่อที่คุณต้องการส่งออก ( ดูเอกสารประกอบ )

__all__ = ['public_class'] # don't add here the 'implementation_class'

รูปแบบที่ฉันใช้เป็นบางครั้งคือ:

กำหนดคลาส:

class x(object):
    def doThis(self):
        ...
    def doThat(self):
        ...

สร้างอินสแตนซ์ของคลาสโดยเขียนทับชื่อคลาส:

x = x()

กำหนดสัญลักษณ์ที่แสดงฟังก์ชันการทำงาน:

doThis = x.doThis
doThat = x.doThat

ลบอินสแตนซ์ตัวเอง:

del x

ตอนนี้คุณมีโมดูลที่เปิดเผยเฉพาะหน้าที่สาธารณะของคุณ

อนุสัญญาจะนำหน้า "_" ไปยังคลาสฟังก์ชันและตัวแปรภายใน

เพื่อแก้ไขปัญหาของข้อตกลงการออกแบบและดังที่คริสโตเฟอร์กล่าวไว้ไม่มีสิ่งที่เรียกว่า "ส่วนตัว" ใน Python สิ่งนี้อาจฟังดูบิดเบี้ยวสำหรับคนที่มาจากพื้นหลัง C / C ++ (เช่นฉันในขณะที่กลับมา) แต่ในที่สุดคุณอาจจะรู้ว่าการประชุมต่อไปนี้มีมากมายเพียงพอ

การเห็นบางสิ่งที่มีขีดล่างอยู่ข้างหน้าควรเป็นคำใบ้ที่ดีพอที่จะไม่ใช้มันโดยตรง หากคุณกังวลกับhelp(MyClass)ผลลัพธ์ที่ไม่เป็นระเบียบ (ซึ่งเป็นสิ่งที่ทุกคนมองเมื่อค้นหาวิธีใช้คลาส) แอตทริบิวต์ / คลาสที่ขีดเส้นใต้จะไม่รวมอยู่ในนั้นดังนั้นคุณจะต้องอธิบายอินเทอร์เฟซ "สาธารณะ" ของคุณ

นอกจากนี้การมีทุกสิ่งที่เป็นสาธารณะก็มีสิทธิประโยชน์ที่ยอดเยี่ยมเช่นคุณสามารถทดสอบหน่วยอะไรก็ได้จากภายนอก (ซึ่งคุณไม่สามารถทำได้ด้วยโครงสร้างส่วนตัวของ C / C ++)

ใช้เครื่องหมายขีดล่างสองอันเพื่อนำหน้าชื่อของตัวระบุ "ส่วนตัว" สำหรับคลาสในโมดูลให้ใช้ขีดล่างนำหน้าเพียงตัวเดียวและจะไม่นำเข้าโดยใช้ "จากการนำเข้าโมดูล *"

class _MyInternalClass:
    def __my_private_method:
        pass

(ไม่มีสิ่งที่เรียกว่า "ส่วนตัว" ที่แท้จริงใน Python ตัวอย่างเช่น Python จะเปลี่ยนชื่อของสมาชิกชั้นเรียนโดยอัตโนมัติด้วยขีดล่างคู่ให้เป็น__clssname_mymemberดังนั้นถ้าคุณรู้จักชื่อที่สับสนคุณก็สามารถใช้เอนทิตี "ส่วนตัว" ได้อยู่ดี . ดูที่นี่.และแน่นอนคุณสามารถเลือกที่จะนำเข้าชั้นเรียนด้วยตนเอง "ภายใน" ถ้าคุณต้องการ)