Skip to content

Add Singleton design pattern example #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

farheen-shaikh530
Copy link

This PR adds a simple implementation of the Singleton design pattern in Python. The example is placed in patterns/singleton.py and includes comments and a small test run.

Copy link
Contributor

@grimley517 grimley517 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The principle is there, but could be more consistent with rest of the repository.

@@ -0,0 +1,17 @@
"""
Singleton Pattern Example
Ensures a class has only one instance and provides a global point of access to it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In line with doctoring standards - could the second line of this doctoring be empty please. (add empty line)

See https://github.com/faif/python-patterns/blob/master/patterns/structural/facade.py for an example of a good docString. Unfortunately there are many poor examples around.

return cls._instance

if __name__ == "__main__":
obj1 = Singleton()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also referring to the facade documentation lines 94-97, this repo uses doctests to establish testing.

Could you follow the same pattern to demonstrate the principle you are demonstrating here..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants