braboj / tutorial-python Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 2.0 47.5 MB

Awesome Python!

Python 99.46% Shell 0.34% Batchfile 0.19%

python tutorial

tutorial-python's Introduction

Hi! 👋

Call me Branko.
I am passionate about code,
With keen interest in exotic food,
But even food cannot beat a good book.

tutorial-python's People

Contributors

Stargazers

Watchers

Forkers

vasc01 jordrag

tutorial-python's Issues

[Part A, ch. 8] - Add function call

There is no call and print of the "factorial" function in the code, to be added with a number for example.

[Part A, ch. 8] - Better description purpose

To improve the description and the comment in the example code for Closures. The idea is to be more clear about the differences between Nested functions and Closures.

[Part A, Ch. 11] - Missing images when compiling the book to a PDF file

The issue arises only when the book is compiled. Compiling PART A will have the images correctly imported in the final PDF document.

Part A, Chapter 12 "Debugging"

Missing image for breakpoints
Missing images for conditional breakpoints
Missing image for watchlists

[Part C, Ch. 4] - Replace copyright images for comparison between coroutine and subroutine

[Part A, ch.8] - Code refactory

Paragraph 8.19. Function Introspection code needs a little refactoring: a regular parameter like c=20 can't be after other with "*", and should be displaced. There are no "__kwdefaults" and "__annotations" parameters in "foo" function.

[Part B] - Proofreading and changes in the examples

Enhance the README file

Running the tests

Build and check for errors
Check for syntax errors
Check for semantic errors
Check for image errors
Check using a light theme
Check using a dark theme

Deployment

ruby
asciidoctor
asciidoctor-pdf

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Hat tip to anyone whose code was used
Inspiration
etc

[Part A, Ch. 9] - Define named constructors

Introduce the term named constructor and add an example to demonstrate how to make one.

[Part A, ch. 9] - Probably misplaced file

In Part A->09_classes->exercise there is a file objects.md. It looks misplaced to me or it is left over from earlier. I didn't remove it as I am not sure if it is still needed.

[Appendix] - Add links to exercise resources and theoretical content websites

Discussed in #24

^{Originally posted by Vasc01 September 15, 2023}

Links to websites with exercise problems related to the topics in the book
Links to websites with expanded explanations on the topics in the book. For example https://realpython.com.

[Part B, Ch. 2] - Review and change example code

2.1. Single Responsibility Principle

examples single_responsibility_bad.py and single_responsibility_good.py

2.2. Open/Closed Principle

examples open_closed_bad.by and open_closed_good.by

2.5. Dependency Inversion Principle

in file dependency_inversion_good.py make MathAbc an abstract class

Update the README file

Review and update the content of the README file.

[Part B, Ch. 3] - Replace copyright images for the bridge pattern

[Appendix] - Add table with the most commonly used data types with key properties

This shall be an image that can be used as a cheatsheet for quick reference.

Create a deployment script

Create a script that:

Checkout the project
Generates the PDF file
Commit the changes

[Part A, Ch. 5] - Add precedence of operators

Discussed in #14

^{Originally posted by Vasc01 September 12, 2023}
I have noticed that in the chapter about operator there is no explanation about precedence of operators. I think listed view and visual example similar to the attached files will be beneficial.

[Part B, Ch. 9] - Add list and dictionary comprehension

Discussed in #22

^{Originally posted by Vasc01 September 14, 2023}
I couldn't find list and dictionary comprehensions in Part A and B. Possibly they can be added to Part A -> Control Flow -> for Statement. At this point the datatypes and for looping is already explained.

Add project files

README.md
REVISIONS.md
RULES.md

[Appendix] - UML reference guide

Organize the folders according to the project rules

See the README file for further explanation...

[Part B, Ch.1] - Add UML diagrams for OOP

Visualize the OOP concepts with UML diagrams
Explain the symbols used in the diagram

Single line code highlight

Code surrounded by apostrophes is not highlighted as expected when the document is exported as PDF.

[Part B, Ch. 2] - Add UML diagrams for SOLID

[Part B, Ch. 3] - Review and update the SOLID chapter

Some of the definitions are not quite clear and need refactoring.

Move the introspection parts from function and classes to a separate chapter

Discussed in #25

^{Originally posted by braboj September 15, 2023}
The topic seems to be too advanced for beginner and advanced users. Maybe it is a good idea to create a separate chapter as part of the expert tutorial and clarify:

Inspections using dunder methods
Inspections using the inspect library
Inspections using the sys library

An inspection is the process of gathering information about live (running) objects.