diff --git a/web/faq.html b/web/faq.html new file mode 100644 index 0000000..144263b --- /dev/null +++ b/web/faq.html @@ -0,0 +1,53 @@ +
Python 2 or Python 3?
+    Python 3.6 (Except for dataclasses and asyncio that require version 3.7). +

+ +
What is the best way to use it?
+    I keep the text file open on separate desktop at all times. It is also in a different text editor than the one I usually use, so it's easier to switch to with Ctrl+↹ / ⌘↹. Cheatsheet consists of minimal text and short examples so things are easy to find with Ctrl+F / ⌘F.

+    I also keep the Python console open at all times to test a little snippets of code, to check out the available functions of a module using code completion and above all, to use help(<module/object/function/type>) command. If something is still unclear, then I search the Python docs by googling 'python docs <module/function>'. +

+ +
Why the '<type>' semantics?
+    It makes examples much less ambiguous. +

+ +
Why are some basics like '<list> = [1, 2, 3]' and '<el> = <list>[<int>]' missing?
+    This cheatsheet is not intended for complete beginners. This way it can save some valuable space. Nonetheless it tries to be simple enough to be useful for somebody who completed the introductory course. A nice one page cheatsheet that can help you get started can be found here.

+ +
What exactly is <el>?
+    El is short for element and can be any object, but it usually denotes an object that is an item of a collection. +

+ +
What exactly is <collection>?
+    Collection is my name for an iterable object. An iterable object in Python is any object that has at least one of iter() and getitem() special methods defined. <object>.__iter__() returns an iterator of object's items and <object>.__getitem__(<index>) returns an item at that index. I chose not to use the name iterable because it sounds scarier and more vague than collection, even though it has a precise definition.

+ +    <iterable> should not be confused with abstract base class collections.abc.Iterable. Expression instanceof(<object>, collections.abc.Iterable) only checks if object has iter() special method. instanceof(<object>, collections.abc.Collection) checks for len(), iter() and contains(). +

+ +
What about PEP 8?
+    Check out Google Style Guide and use Ctrl+Alt+L / ⌥⌘L shortcut in PyCharm to automatically reformat code. +

+ +
Why are import statement, virtual environment, tests, packaging and installation not covered?
+    Check out The Hitchhiker’s Guide to Python for a nice overview of mentioned topics. +

+ +
Why are Django and Pandas not covered?
+    Maybe they will be in the future. For now here is a nice Django cheatsheet. +

+ +
Why are there no concrete Regex examples?
+    Regular expressions are a separate technology that is independent from Python. There are many resources available online. +

+ +
Why is there no old style string formating?
+    Because it's redundant and I don't want to encourage its use. +

+ +
Why is staticmethod not covered in Class section?
+    Because it's of very limited use and is easy to mix up with classmethod. +

+ +
Why are descriptors not covered?
+    Because property is sufficient for everyday use. +

\ No newline at end of file diff --git a/web/image_social_2.png b/web/image_social_2.png new file mode 100755 index 0000000..f119c6c Binary files /dev/null and b/web/image_social_2.png differ