diff options
| -rw-r--r-- | languages/python.md | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/languages/python.md b/languages/python.md index 2b38171..5a3d6a1 100644 --- a/languages/python.md +++ b/languages/python.md @@ -1,4 +1,10 @@ +Python Documentation: https://docs.python.org +curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py +python get-pip.py +use this in nvim :help python + +pip --version Planning to develop some python application or python package your best option is use virtual environments. Try virtualenv or even conda @@ -16,3 +22,174 @@ source yourenv/bin/activate pip install package-name When you create this environment yourenv, you will setup pip to install packages only into this environment, not to the entire system. +Basic Syntax +Comments + +python + +# This is a single-line comment + +""" +This is a +multi-line comment +""" + +Variables + +python + +# Declaration and initialization +x = 10 + +# Declaration without initialization +y = None + +Data Types +Data Type Description +int Integer Represents whole numbers without a fractional component +float Float Represents real numbers with a single-precision format +str String Represents a sequence of characters +bool Boolean Represents a logical value, either True or False +list List Represents an ordered, mutable collection of elements +tuple Tuple Represents an ordered, immutable collection of elements +dict Dictionary Represents a collection of key-value pairs +set Set Represents an unordered collection of unique elements +Arithmetic Operators + + Addition: x + y + Subtraction: x - y + Multiplication: x * y + Division: x / y + Modulus: x % y + Exponentiation: x ** y + Floor Division: x // y + +String Operations + +python + +string = "Hello, World!" + +len(string) # Length of string +string.upper() # Convert to uppercase +string.lower() # Convert to lowercase +string.strip() # Remove whitespace +string.split(",") # Split by comma + +Control Flow + + Conditional Statements + +python + +if condition: + # Code to execute if condition is true +elif another_condition: + # Code to execute if another_condition is true +else: + # Code to execute if neither condition is true + + Loops + +python + +for item in iterable: + # Code to execute for each item in iterable + +while condition: + # Code to execute while condition is true + +Functions + +python + +def function_name(parameter1, parameter2): + # Code to execute + return result # Optional return statement + +Data Structures + + Lists + +python + +my_list = [1, 2, 3, 4, 5] + +my_list.append(6) # Add item to the end of the list +my_list.insert(0, 0) # Insert item at a specific index +my_list.remove(3) # Remove item from the list +my_list.pop() # Remove and return the last item +my_list.sort() # Sort the list + + Dictionaries + +python + +my_dict = {"key1": "value1", "key2": "value2"} + +my_dict["key3"] = "value3" # Add a new key-value pair +del my_dict["key2"] # Delete a key-value pair +my_dict.keys() # Get all keys +my_dict.values() # Get all values +my_dict.items() # Get all key-value pairs + + Sets + +python + +my_set = {1, 2, 3} + +my_set.add(4) # Add an element to the set +my_set.remove(3) # Remove an element from the set + + Python is case-sensitive (e.g., variable and Variable are different). + Python uses indentation (usually four spaces) to define code blocks. Indentation is important for the structure and readability of your code. + Statements are terminated with a newline. However, you can use a backslash (\) to continue a statement to the next line. + Python follows the "PEP 8" style guide, which suggests guidelines for writing Python code. Some key points include: + Use descriptive variable and function names. + Use lowercase letters with words separated by underscores for variable and function names (e.g., my_variable, my_function). + Use uppercase letters with words separated by underscores for constants (e.g., MY_CONSTANT). + Use spaces around operators and after commas (e.g., x = 5 + 2, my_function(arg1, arg2)). + Limit line length to 79 characters. + Python supports both single-quoted (') and double-quoted (") strings. Use whichever is more appropriate for your case, but be consistent. + Python uses zero-based indexing for lists, tuples, and strings. The first element is accessed with index 0. + Python allows for multiple assignment in a single line, e.g., x, y = 10, 20. + Python has no mandatory declaration of variables. Variables are created when a value is assigned to them. + Python uses the None value to represent the absence of a value or a null value. + Python has a dynamic type system, meaning you can reassign variables to different types. + Python is an interpreted language, which means it is not compiled but executed line by line. + Use meaningful comments to explain the purpose and functionality of your code. + Python uses the # symbol to denote single-line comments. + Use docstrings (multi-line comments enclosed in triple quotes) to provide documentation for functions, classes, and modules. + Use the backslash (\) to continue a statement onto the next line when necessary. + Use parentheses to group expressions and clarify the order of operations. + Avoid using single-character variable names, except in cases where the purpose is clear (e.g., loop counters). + Follow the DRY (Don't Repeat Yourself) principle and avoid duplicating code. Instead, use functions or loops to encapsulate and reuse code. + Use meaningful names for variables, functions, and classes that reflect their purpose and intent. + Use snake_case naming convention for functions, variables, and modules (e.g., my_function, my_variable, my_module.py). + Use CamelCase naming convention for classes (e.g., MyClass). + Use appropriate spacing around operators and after commas to enhance readability. + Follow proper code formatting by using consistent indentation and line breaks. + Avoid unnecessary or excessive code comments that only restate the code itself. + Make use of white space to improve code readability, such as adding blank lines between functions or sections of code. + Use built-in functions and libraries whenever possible to leverage existing functionality and improve code efficiency. + Use a consistent naming convention for constants, such as using uppercase letters with underscores (e.g., MAX_VALUE). + Avoid using global variables whenever possible, as they can lead to code complexity and make debugging difficult. +curl -OJL https://docs.python.org/3/archives/python-3.9.7-docs-html.tar.bz2 + +tar -xvf python-3.9.7-docs-html.tar.bz2 +After extraction, you can navigate to the extracted directory and open the index.html file in a web browser to access the offline Python documentation. +or to generate the documentation for a specific Python module or package, use the following command: + +pydoc -w module_name + +Replace module_name with the name of the module or package for which you want to generate documentation. For example, to generate documentation for the os module, you can use: + + +pydoc -w os + +Additionally, you can use the -p option with pydoc to launch a local web server and view the documentation in your web browser. For example: + + +pydoc -p 5000 +This command will start a web server on port 5000, and you can access the documentation by opening your browser and navigating to http://localhost:5000. |