From 63c74becf0cc9ba2b8a386458e0837d1ee778819 Mon Sep 17 00:00:00 2001 From: Lyndsy Simon Date: Mon, 3 Jun 2013 08:53:56 -0400 Subject: [PATCH 0001/1051] Removes completed TODO re: scientific Python --- docs/scenarios/scientific.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst index 031721091..7f9a66cb3 100644 --- a/docs/scenarios/scientific.rst +++ b/docs/scenarios/scientific.rst @@ -43,8 +43,6 @@ Virtual Machine) (through special decorators). Briefly, Numba using system that compiles Python code with LLVM to code which can be natively executed at runtime. -.. todo:: Write about Numba - SciPy ----- From f4e3c36d6c7a59810e8aebac5a7a2398139245df Mon Sep 17 00:00:00 2001 From: Lyndsy Simon Date: Mon, 3 Jun 2013 08:56:04 -0400 Subject: [PATCH 0002/1051] Adds Sphinx to requirements.txt --- requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 663bd1f6a..f47f24596 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ -requests \ No newline at end of file +requests +sphinx From 598c5695b79b15672e679b1567a2fa7f7d220298 Mon Sep 17 00:00:00 2001 From: kuyan Date: Wed, 12 Jun 2013 19:39:32 -0700 Subject: [PATCH 0003/1051] Correct spelling of 'aforementioned'. --- docs/writing/gotchas.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/writing/gotchas.rst b/docs/writing/gotchas.rst index 45c0e5605..d96d3d848 100644 --- a/docs/writing/gotchas.rst +++ b/docs/writing/gotchas.rst @@ -2,11 +2,11 @@ Common Gotchas ============== For the most part, Python aims to be a clean and consistent language that -avoids surprises, but there are a few cases where newcomers to the language -often get tripped up. +avoids surprises. However, there are a few cases that can be confusing to +newcomers. -Some of these are intentional but potentially surprising. Some could arguably -be considered language warts. In general though, what follows is a collection +Some of these cases are intentional but can be potentially surprising. Some +could arguably be considered language warts. In general though, what follows is a collection of potentially tricky behavior that might seem strange at first glance, but is generally sensible once you're aware of the underlying cause for the surprise. @@ -157,7 +157,7 @@ What You Should Do Instead ~~~~~~~~~~~~~~~~~~~~~~~~~~ The most general solution is arguably a bit of a hack. Due to Python's -afformentioned behavior concerning evaluating default arguments to functions +aforementioned behavior concerning evaluating default arguments to functions (see :ref:`default_args`), you can create a closure that binds immediately to its arguments by using a default arg like so: From c1f649cc6ba50d896ecc503d0e1ae89273bfd671 Mon Sep 17 00:00:00 2001 From: kuyan Date: Wed, 12 Jun 2013 19:56:48 -0700 Subject: [PATCH 0004/1051] Nitpicky rewordings and grammar fixes. --- docs/starting/which-python.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst index 7c995ac83..8d4c01265 100644 --- a/docs/starting/which-python.rst +++ b/docs/starting/which-python.rst @@ -52,11 +52,11 @@ level of compatibility with Python packages and C extension modules. If you are writing open-source Python code and want to reach the widest possible audience, targeting CPython is your best bet. If you need to use any packages -that rely on C extensions for their functionality (eg: numpy) then CPython +that rely on C extensions for their functionality (e.g. numpy) then CPython is your only choice. Being the reference implementation, all versions of the Python language are -available as CPython. Python 3 is only available in a CPython implementation. +available as CPython. Python 3 is only available as a CPython implementation. PyPy ---- @@ -78,14 +78,14 @@ Jython ------ `Jython `_ is a Python implementation that compiles -Python code to Java byte code that then executes on a JVM. It has the additional -advantage of being able to import and use any Java class the same as a Python +Python code to Java byte code that is then executed in a JVM. It has the additional +advantage of being able to import and use any Java class like a Python module. If you need to interface with an existing Java codebase or have other reasons to need to write Python code for the JVM, Jython is the best choice. -Currently Jython supports up to Python 2.5. [#jython_ver]_ +Jython currently supports up to Python 2.5. [#jython_ver]_ IronPython ---------- @@ -95,7 +95,7 @@ framework. It can use both Python and .NET framework libraries, and can also expose Python code to other .NET languages. `Python Tools for Visual Studio `_ integrates -IronPython directly in to the Visual Studio development environment, making it +IronPython directly into the Visual Studio development environment, making it an ideal choice for Windows developers. IronPython supports Python 2.7. [#iron_ver]_ From 8c5ba090489f280ba83c50c2cd400dd28d0dd4b3 Mon Sep 17 00:00:00 2001 From: kuyan Date: Wed, 12 Jun 2013 20:33:00 -0700 Subject: [PATCH 0005/1051] Add line breaks for conformance with the Style Guide. --- docs/scenarios/gui.rst | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index 49dd0ad5e..3af9a91b9 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -29,7 +29,11 @@ PyObjC wxPython -------- -wxPython is a GUI toolkit for the Python programming language. It allows Python programmers to create programs with a robust, highly functional graphical user interface, simply and easily. It is implemented as a Python extension module (native code) that wraps the popular wxWidgets cross platform GUI library, which is written in C++. +wxPython is a GUI toolkit for the Python programming language. It allows +Python programmers to create programs with a robust, highly functional +graphical user interface, simply and easily. It is implemented as a Python +extension module (native code) that wraps the popular wxWidgets cross platform +GUI library, which is written in C++. Install (Stable) ~~~~~~~~~~~~~~~~ @@ -60,10 +64,15 @@ available on the `Python Wiki `_. Kivy ---- -`Kivy `_ is a Python library for development of multi-touch enabled media rich applications. The aim is to allow for quick and easy interaction design and rapid prototyping, while making your code reusable and deployable. +`Kivy `_ is a Python library for development of multi-touch +enabled media rich applications. The aim is to allow for quick and easy +interaction design and rapid prototyping, while making your code reusable +and deployable. -Kivy is written in Python, based on OpenGL and supports different input devices such as: Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch, Apple's products and so on. +Kivy is written in Python, based on OpenGL and supports different input devices +such as: Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch, Apple's products and so on. -Kivy is actively being developed by a community and free to use. It operates on all major platforms (Linux, OSX, Windows, Android). +Kivy is actively being developed by a community and free to use. It operates +on all major platforms (Linux, OSX, Windows, Android). The main resource for information is the website: http://kivy.org From fa99cd86e32d79b5181d5ae692b3e126c9f515d9 Mon Sep 17 00:00:00 2001 From: kuyan Date: Wed, 12 Jun 2013 20:33:45 -0700 Subject: [PATCH 0006/1051] GtK --> GTK --- docs/scenarios/gui.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index 3af9a91b9..7194f57bd 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -40,7 +40,7 @@ Install (Stable) *Go to http://www.wxpython.org/download.php#stable and download the appropriate package for your OS.* -Gtk +GTk --- PyGTK provides Python bindings for the GTK+ toolkit. Like the GTK+ library itself, it is currently licensed under the GNU LGPL. It is worth noting that From b832bb907dc31d8f97716a3c89a3b08439186c19 Mon Sep 17 00:00:00 2001 From: kuyan Date: Wed, 12 Jun 2013 20:35:15 -0700 Subject: [PATCH 0007/1051] 'many' --> 'much' --- docs/scenarios/network.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/scenarios/network.rst b/docs/scenarios/network.rst index b01c0efe5..56031aa9d 100644 --- a/docs/scenarios/network.rst +++ b/docs/scenarios/network.rst @@ -4,10 +4,10 @@ Networking Twisted ------- -`Twisted `_ is an event-driven networking engine. It can be -used to build applications around many different networking protocols, including http servers -and clients, applications using SMTP, POP3, IMAP or SSH protocols, instant messaging and -`many more `_. +`Twisted `_ is an event-driven networking +engine. It can be used to build applications around many different networking +protocols, including http servers and clients, applications using SMTP, POP3, +IMAP or SSH protocols, instant messaging and `much more `_. PyZMQ ----- From 16d92c428d677187437a2cb0e56ff9e906006508 Mon Sep 17 00:00:00 2001 From: kuyan Date: Wed, 12 Jun 2013 20:51:15 -0700 Subject: [PATCH 0008/1051] PEP and Python are capitalized. --- docs/dev/env.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/dev/env.rst b/docs/dev/env.rst index 56301fc9f..bdab904bb 100644 --- a/docs/dev/env.rst +++ b/docs/dev/env.rst @@ -14,7 +14,7 @@ VIM Vim is a text editor which uses keyboard shortcuts for editing instead of menus or icons. There exist a couple of plugins and settings for the VIM editor to -aid python development. If you only develop in Python, a good start is to set +aid Python development. If you only develop in Python, a good start is to set the default settings for indentation and line-wrapping to values compliant with `PEP 8 `_. In your home directory, open a file called `.vimrc` and add the following lines::: @@ -29,7 +29,7 @@ open a file called `.vimrc` and add the following lines::: With these settings, newlines are inserted after 79 characters and indentation is set to 4 spaces per tab. If you also use VIM for other languages, there is a -handy plugin at indent_, which handles indentation settings for python source +handy plugin at indent_, which handles indentation settings for Python source files. There is also a handy syntax plugin at syntax_ featuring some improvements over @@ -67,12 +67,12 @@ Python-mode Python-mode_ is a complex solution in VIM for working with python code. It has: -- Async python code checking (pylint, pyflakes, pep8, mccabe) in any combination +- Async Python code checking (pylint, pyflakes, pep8, mccabe) in any combination - Code refactoring and autocompletion with Rope -- Fast python folding +- Fast Python folding - Virtualenv support -- Search by python documentation and run python code -- Auto pep8 error fixes +- Search by Python documentation and run Python code +- Auto PEP8 error fixes And more. @@ -148,7 +148,7 @@ Spyder ------ `Spyder `_ is an IDE specifically geared -toward working with scientific python libraries (namely `Scipy `_). +toward working with scientific Python libraries (namely `Scipy `_). It includes integration with pyflakes_, `pylint `_, and `rope `_. @@ -159,7 +159,7 @@ class and function browser, and object inspection. WingIDE ------- -`WingIDE `_ is a python specific IDE. It runs on Linux, +`WingIDE `_ is a Python specific IDE. It runs on Linux, Windows, and Mac (as an X11 application, which frustrates some Mac users). WingIDE offers code completion, syntax highlighting, source browser, graphical From 0eff17af228b634c74b8282e2dbdd95ff3e101e6 Mon Sep 17 00:00:00 2001 From: kuyan Date: Thu, 13 Jun 2013 00:51:26 -0700 Subject: [PATCH 0009/1051] 'async' --> 'asynchronous' --- docs/dev/env.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev/env.rst b/docs/dev/env.rst index bdab904bb..7ec103539 100644 --- a/docs/dev/env.rst +++ b/docs/dev/env.rst @@ -67,7 +67,7 @@ Python-mode Python-mode_ is a complex solution in VIM for working with python code. It has: -- Async Python code checking (pylint, pyflakes, pep8, mccabe) in any combination +- Asynchronous Python code checking (pylint, pyflakes, pep8, mccabe) in any combination - Code refactoring and autocompletion with Rope - Fast Python folding - Virtualenv support From 9667754f9527a45b09a5342d8e5ee0c8bc3dd3b1 Mon Sep 17 00:00:00 2001 From: kuyan Date: Thu, 13 Jun 2013 00:55:17 -0700 Subject: [PATCH 0010/1051] Code block type is 'console', not 'bash'. --- docs/scenarios/admin.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst index 3397d6632..481b3410a 100644 --- a/docs/scenarios/admin.rst +++ b/docs/scenarios/admin.rst @@ -4,13 +4,14 @@ Systems Administration Fabric ------ -`Fabric `_ is a library for simplifying system administration tasks. While Chef -and Puppet tend to focus on managing servers and system libraries, -fabric is more focused on application level tasks such as deployment. +`Fabric `_ is a library for simplifying system +administration tasks. While Chef and Puppet tend to focus on managing servers +and system libraries, fabric is more focused on application level tasks such +as deployment. Install Fabric: -.. code-block:: bash +.. code-block:: console $ pip install fabric @@ -40,7 +41,7 @@ server. With the previous code saved in a file named fabfile.py, we can check memory usage with: -.. code-block:: bash +.. code-block:: console $ fab memory_usage [my_server1] Executing task 'memory' @@ -59,7 +60,7 @@ usage with: and we can deploy with: -.. code-block:: bash +.. code-block:: console $ fab deploy @@ -78,7 +79,7 @@ multiple servers using simple template files. Salt supports python versions 2.6 and 2.7 and can be installed via pip: -.. code-block:: bash +.. code-block:: console $ pip install salt @@ -87,7 +88,7 @@ shell commands or use pre-built modules of complex commands on our minions. The following command lists all available minion hosts, using the ping module. -.. code-block:: bash +.. code-block:: console $ salt '*' test.ping @@ -98,7 +99,7 @@ provide a host taxonomy for the salt modules. The following command lists all available minions running CentOS using the grains system: -.. code-block:: bash +.. code-block:: console $ salt -G 'os:CentOS' test.ping From b68582609b551a00f597821e17146dd5a6e867d0 Mon Sep 17 00:00:00 2001 From: kuyan Date: Thu, 13 Jun 2013 19:31:48 -0700 Subject: [PATCH 0011/1051] Added note about OSX-GCC-Installer and Xcode conflict. --- docs/starting/install/osx.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst index 2384a64ed..6d2a156f2 100644 --- a/docs/starting/install/osx.rst +++ b/docs/starting/install/osx.rst @@ -26,6 +26,11 @@ by downloading `XCode `_, the smaller Apple account) or the even smaller `OSX-GCC-Installer `_ package. +.. note:: + If you already have XCode installed, do not install OSX-GCC-Installer. + In combination, the software can cause issues that are difficult to + diagnose. + While Lion comes with a large number of UNIX utilities, those familiar with Linux systems will notice one key component missing: a decent package manager. `Homebrew `_ fills this void. From 925818a8278952c942f8a5699044bf4f055e3848 Mon Sep 17 00:00:00 2001 From: Martin Puppe Date: Thu, 20 Jun 2013 00:17:43 +0300 Subject: [PATCH 0012/1051] Fix link to Dive Into Python 3 --- docs/intro/learning.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst index 5425d84f3..b412311ab 100644 --- a/docs/intro/learning.rst +++ b/docs/intro/learning.rst @@ -39,7 +39,7 @@ Dive Into Python 3 is a good book for those ready to jump in to Python 3. It's a good read if you are moving from Python 2 to 3 or if you already have some experience programming in another language. - `Dive Into Python 3 `_ + `Dive Into Python 3 `_ Think Python: How to Think Like a Computer Scientist ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 8d6f737438a3cb9f8109c350745ab4b7808ed550 Mon Sep 17 00:00:00 2001 From: Arthur Loder Date: Fri, 21 Jun 2013 22:35:10 -0400 Subject: [PATCH 0013/1051] minor formatting changes. --- docs/conf.py | 2 +- docs/writing/license.rst | 12 ++++++------ docs/writing/style.rst | 2 +- docs/writing/tests.rst | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fc31228e7..f5effd924 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,7 +46,7 @@ # General information about the project. project = u'pythonguide' -copyright = u'2013. A Kenneth Reitz Project. Creative Commons Share-Alike 3.0.' +copyright = u'2013. A Kenneth Reitz Project. Creative Commons Share-Alike 3.0' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/writing/license.rst b/docs/writing/license.rst index 9e759baf6..6f0df77d2 100644 --- a/docs/writing/license.rst +++ b/docs/writing/license.rst @@ -14,22 +14,22 @@ from. In general, these licenses tend to fall into one of two categories: 1. licenses that focus more on the user's freedom to do with the - software as they please (these are the more-permissive open + software as they please (these are the more permissive open source licenses such as the MIT, BSD, & Apache). 2. licenses that focus more on making sure that the code itself — including any changes made to it and distributed along with it — - always remains free (these are the less-permissive free software - licenses, for example, the GPL and LGPL). + always remains free (these are the less permissive free software + licenses such as the GPL and LGPL). -The latter are less-permissive in the sense that they don't permit +The latter are less permissive in the sense that they don't permit someone to add code to the software and distribute it without also including the source code for their changes. To help you choose one for your project, there's a `license chooser `_, **use it**. -**More-Permissive** +**More Permissive** - PSFL (Python Software Foundation License) -- for contributing to python itself - MIT / BSD / ISC @@ -40,7 +40,7 @@ To help you choose one for your project, there's a `license chooser `_ and at `Stack Overflow `_. Idiomatic Python code is often referred to as being *Pythonic*. diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst index 70c08f577..492e47a0d 100644 --- a/docs/writing/tests.rst +++ b/docs/writing/tests.rst @@ -146,7 +146,7 @@ py.test is a no-boilerplate alternative to Python's standard unittest module. $ pip install pytest -Despite being a fully-featured and extensible test tool it boasts a simple +Despite being a fully-featured and extensible test tool, it boasts a simple syntax. Creating a test suite is as easy as writing a module with a couple of functions From 7e7e3d02e657101ef902b257f7b586ab4a231315 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 29 Jun 2013 20:18:17 +0200 Subject: [PATCH 0014/1051] Rewrite section on choosing a Python version --- docs/starting/which-python.rst | 39 +++++++++++++++------------------- 1 file changed, 17 insertions(+), 22 deletions(-) diff --git a/docs/starting/which-python.rst b/docs/starting/which-python.rst index 7c995ac83..e07ad4bc1 100644 --- a/docs/starting/which-python.rst +++ b/docs/starting/which-python.rst @@ -3,37 +3,32 @@ Picking an Interpreter .. _which-python: -Which Python to use? - - -2.x vs 3.x -~~~~~~~~~~ - - Python 2.x is the status quo, Python 3.x is the shiny new thing. - - -`Further Reading `_ - - -Today ------ +Today (Python 2) +~~~~~~~~~~~~~~~~ If you're choosing a Python interpreter to use, I *highly* recommend you use Python 2.7.x, unless you have a strong reason not to. +Also use Python 2.7.x if you're starting to work on a new Python module. If you +have managed to get it working on 2.7, you can add support for older 2.x +versions. -The Future ----------- +The Future (Python 3) +~~~~~~~~~~~~~~~~~~~~~ -As more and more modules get ported over to Python3, the easier it will be for -others to use it. + Python 2.x is the status quo, Python 3.x is the shiny new thing. +`Further Reading `_ -Which Python to Support? -~~~~~~~~~~~~~~~~~~~~~~~~ +Python 3, on the other hand, differs much more greatly from Python 2, so +writing code that works both on Python 2 and Python 3 is a very complicated +process. -If you're starting work on a new Python module, I recommend you write it for -Python 2.5 or 2.6, and add support for Python3 in a later iteration. +It is still possible to `write code that works on Python 2.6, 2.7 and 3.3 +`_. Depending on +the kind of software you are writing, this might be either tricky or extremely +hard, and if you're a beginner there are much more important things to worry +about. Implementations ~~~~~~~~~~~~~~~ From 4651e48d37f96f40c97c776245c4b18599e2e503 Mon Sep 17 00:00:00 2001 From: Konstantin Molchanov Date: Thu, 4 Jul 2013 23:53:08 +0400 Subject: [PATCH 0015/1051] [+] Scenarios: CLI: Added docopt description. --- docs/scenarios/cli.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index bc952c74f..2416125f7 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -7,3 +7,8 @@ Clint ----- .. todo:: Write about Clint + +docopt +------ + +`docopt `_ is a lightweight, highly Pythonic package that allows creating command line interfaces easily and intuitively, by parsing POSIX-style usage instructions. From 93cb68e3081aed10f2fdb4a8458a8347b522f01c Mon Sep 17 00:00:00 2001 From: Roland van Laar Date: Sat, 20 Jul 2013 09:08:59 +0200 Subject: [PATCH 0016/1051] Fix link to tox documentation. --- docs/writing/tests.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst index 492e47a0d..fdbd6715e 100644 --- a/docs/writing/tests.rst +++ b/docs/writing/tests.rst @@ -217,7 +217,7 @@ multiple interpreter configurations tox allows you to configure complicated multi-parameter test matrices via a simple ini-style configuration file. - `tox `_ + `tox `_ Unittest2 --------- From 963ab0aabff4f782364be233e1b9e6547596e071 Mon Sep 17 00:00:00 2001 From: Matthew Boehm Date: Sun, 28 Jul 2013 10:20:47 -0400 Subject: [PATCH 0017/1051] Fix enumerate code snippet to run without error message Code previously added numbers to strings, which results in a TypeError --- docs/writing/style.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/writing/style.rst b/docs/writing/style.rst index 1fbf637d6..f9146493a 100644 --- a/docs/writing/style.rst +++ b/docs/writing/style.rst @@ -548,11 +548,11 @@ keep a count of your place in the list. .. code-block:: python for i, item in enumerate(a): - print i + ", " + item + print i, item # prints - # 0, 3 - # 1, 4 - # 2, 5 + # 0 3 + # 1 4 + # 2 5 The ``enumerate`` function has better readability than handling a counter manually. Moreover, From d08407291a209bcdda96fa63e3cb9abca8ab937a Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Mon, 29 Jul 2013 14:18:20 +0200 Subject: [PATCH 0018/1051] entry about different tutorials added --- Readme.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Readme.rst b/Readme.rst index a789e7fee..b0e60c62c 100644 --- a/Readme.rst +++ b/Readme.rst @@ -26,6 +26,7 @@ Topics include: - Testing. Jenkins + tox guides. - How to interface w/ hg from git easily - what libraries to use for what +- Different tutorials If you are not fond of reading reStructuredText, there is an almost up-to-date `HTML version at docs.python-guide.org From 2fbb7ddf3f27c623962ba84cf1a26e7c8ebb4607 Mon Sep 17 00:00:00 2001 From: kuyan Date: Mon, 29 Jul 2013 21:59:59 -0700 Subject: [PATCH 0019/1051] Added note on Python 3 and Pillow. --- docs/scenarios/imaging.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/scenarios/imaging.rst b/docs/scenarios/imaging.rst index 8defa0b73..f55815797 100644 --- a/docs/scenarios/imaging.rst +++ b/docs/scenarios/imaging.rst @@ -20,8 +20,9 @@ Installation PIL has a reputation of not being very straightforward to install. Listed below are installation notes on various systems. -Also, there's a fork named `Pillow `_ which is easier -to install. It has good setup instructions for all platforms. +Also, there's a fork named `Pillow `_ which +is easier to install. It has good setup instructions for all platforms and +supports Python 3 (PIL currently does not). Installing on Linux ~~~~~~~~~~~~~~~~~~~ From 63fecf8808ed942bb7bf17eede67f8a61085653d Mon Sep 17 00:00:00 2001 From: kuyan Date: Tue, 30 Jul 2013 00:06:29 -0700 Subject: [PATCH 0020/1051] Completely recommend Pillow over PIL. --- docs/scenarios/imaging.rst | 63 +++++--------------------------------- 1 file changed, 8 insertions(+), 55 deletions(-) diff --git a/docs/scenarios/imaging.rst b/docs/scenarios/imaging.rst index f55815797..171043228 100644 --- a/docs/scenarios/imaging.rst +++ b/docs/scenarios/imaging.rst @@ -9,67 +9,20 @@ Python Imaging Library ---------------------- The `Python Imaging Library `_, or PIL -for short, is *the* library for image manipulation in Python. +for short, is *the* library for image manipulation in Python. Unfortunately, its +development has stagnated, with its last release in 2009. -It works with Python 1.5.2 and above, including 2.5, 2.6 and 2.7. Unfortunately, -it doesn't work with 3.0+ yet. +Lucky for you, there's an actively-developed fork of PIL called `Pillow `_ - +it's easier to install, runs on all operating systems, and supports Python 3. Installation ~~~~~~~~~~~~ -PIL has a reputation of not being very straightforward to install. Listed below -are installation notes on various systems. +Before installing Pillow, you'll have to install Pillow's prerequisites. Find +the instructions for your platform `here `_. -Also, there's a fork named `Pillow `_ which -is easier to install. It has good setup instructions for all platforms and -supports Python 3 (PIL currently does not). - -Installing on Linux -~~~~~~~~~~~~~~~~~~~ - -Arch Linux -`````````` - -PIL is maintained in the official community repository, and installed with the system installer as: - -.. code-block:: bash - - $ sudo pacman -S python2-imaging - -Ubuntu 12.10 -```````````` - -Can be installed on the command line as: - -.. code-block:: bash - - $ sudo apt-get install python-imaging - - -Installing on Mac OS X -~~~~~~~~~~~~~~~~~~~~~~ - -PIP doesn't know about the Mac OS X Freetype paths. To rectify that: - -.. code-block:: bash - - $ ln -s /usr/X11/include/freetype2 /usr/local/include/ - $ ln -s /usr/X11/include/ft2build.h /usr/local/include/ - $ ln -s /usr/X11/lib/libfreetype.6.dylib /usr/local/lib/ - $ ln -s /usr/X11/lib/libfreetype.6.dylib /usr/local/lib/libfreetype.dylib - -then: +After that, it's straightforward: .. code-block:: bash - $ brew install libjpeg - $ pip install PIL - - -Installing on Windows -~~~~~~~~~~~~~~~~~~~~~ - -.. todo:: - Notes on installing on Windows machines - - + $ pip install Pillow From 60cdeae7f7e4d1cfb4d3dd9428b13ce667b0c44a Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Tue, 30 Jul 2013 10:37:24 +0200 Subject: [PATCH 0021/1051] Tornado web server and Jinja2 template engine with example added --- docs/scenarios/web.rst | 130 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst index 1520b4bbc..2093c15cc 100644 --- a/docs/scenarios/web.rst +++ b/docs/scenarios/web.rst @@ -90,6 +90,15 @@ application that is not commonly found in other web frameworks. Support can be found on its `mailing list `_. +Tornado +-------- +`Tornado `_ is a scalable, non-blocking web server and web application framework with +a relative simple usage. Tornado is known for his high performance. +It was initially developed for `friendfeed `_ , a real time chat and blog system. + +In the Jinja2 template engine example it is used to serve the rendered pages. + + Pyramid -------- @@ -269,6 +278,127 @@ and to the templates themselves. the parts where the HTML template passes some variable content to the javascript code. + + +Jinja2 +------ +`Jinja2 `_ is a template engine which is similar to the Django template system with some extra features. It is a text-based template +language and thus can be used to generate any markup. It allows customization of filters, tags, tests and globals. +Unlike the template system implemented in the Django Framework it allows to call functions. The Code is staying under the BSD license. + +Here some important html tags in jinja2: + +.. code-block:: html + + {# This is a comment #} + {# The next tag is a variable output: #} + {{title}} + {# Tag for a block, can be replaced through inheritance with other html code #} + {% block head %} +

I'm the head!

-

Feedback

+

Contributors

- Feedback is greatly appreciated. If you have any questions, comments, - random praise, or anonymous threats, - shoot me an email. + This work is a result of collaboration of + 135+ people + around the world, and your contribution + is welcome too.

From 832f69841002a71edad95db78777fa8324eb5243 Mon Sep 17 00:00:00 2001 From: Chen Liu Date: Mon, 10 Feb 2014 22:52:16 -0800 Subject: [PATCH 0120/1051] update intro section: add Pro Python link --- docs/intro/community.rst | 2 +- docs/intro/learning.rst | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/intro/community.rst b/docs/intro/community.rst index 05cd14820..f54caffea 100644 --- a/docs/intro/community.rst +++ b/docs/intro/community.rst @@ -75,7 +75,7 @@ The major events for the Python community are developer conferences. The two most notable conferences are PyCon, which is held in the US, and its European sibling, EuroPython. -A comprehensive list of conferences is maintained `at pycon.org `_. +A comprehensive list of conferences is maintained at `pycon.org `_. Python User Groups diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst index 2e463edc6..bd2ca6d7d 100644 --- a/docs/intro/learning.rst +++ b/docs/intro/learning.rst @@ -104,6 +104,8 @@ Pro Python This book is for intermediate to advanced Python programmers who are looking to understand how and why Python works the way it does and how they can take their code to the next level. + `Pro Python `_ + Expert Python Programming ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -145,7 +147,7 @@ chosen from mathematics and the natural sciences. Numerical Methods in Engineering with Python ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Numerical Methods in Engineering with Python,written by Jaan Kiusalaas, attempts to +Numerical Methods in Engineering with Python, written by Jaan Kiusalaas, attempts to emphasis on numerical methods and how to implement them in Python. `Numerical Methods in Engineering with Python `_ From dcaa25d0a6193ef16df32c68eba3776b5ff5d449 Mon Sep 17 00:00:00 2001 From: Chen Liu Date: Tue, 11 Feb 2014 21:49:35 -0800 Subject: [PATCH 0121/1051] remote duplicate Chef in admin.rst --- docs/scenarios/admin.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst index 84c98da13..fd4645485 100644 --- a/docs/scenarios/admin.rst +++ b/docs/scenarios/admin.rst @@ -177,7 +177,6 @@ A full terminal application like a widely extended top which is based on psutil monitoring is `glance `_. Ansible -Chef ---- .. todo:: Write about Ansible From 2b78a936f3ed924961731d607260383b65882f73 Mon Sep 17 00:00:00 2001 From: Chen Liu Date: Tue, 11 Feb 2014 22:11:12 -0800 Subject: [PATCH 0122/1051] add link to Numba --- docs/scenarios/scientific.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst index 0d45807fa..e95506517 100644 --- a/docs/scenarios/scientific.rst +++ b/docs/scenarios/scientific.rst @@ -53,10 +53,11 @@ NumPy is compatible with Python versions 2.4 through to 2.7.2 and 3.1+. Numba ----- -Numba is an Numpy aware Python compiler (just-in-time (JIT) specializing -compiler) which compiles annotated Python (and Numpy) code to LLVM (Low Level -Virtual Machine) (through special decorators). -Briefly, Numba using system that compiles Python code with LLVM to code which + +`Numba `_ is an Numpy aware Python compiler +(just-in-time (JIT) specializing compiler) which compiles annotated Python (and +Numpy) code to LLVM (Low Level Virtual Machine) (through special decorators). +Briefly, Numba using system that compiles Python code with LLVM to code which can be natively executed at runtime. SciPy From a8e7b57758fa296df206675283c5059d04f9a173 Mon Sep 17 00:00:00 2001 From: Chen Liu Date: Tue, 11 Feb 2014 22:19:21 -0800 Subject: [PATCH 0123/1051] update untangle link --- docs/scenarios/xml.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/scenarios/xml.rst b/docs/scenarios/xml.rst index ee97e2d02..3e01b2fe6 100644 --- a/docs/scenarios/xml.rst +++ b/docs/scenarios/xml.rst @@ -4,8 +4,8 @@ XML parsing untangle -------- -`untangle `_ is a simple library which takes -an XML document and returns a Python object which mirrors the nodes and +`untangle `_ is a simple library which +takes an XML document and returns a Python object which mirrors the nodes and attributes in its structure. For example, an XML file like this: From 04718556af6597a2d6163e5f11eac1c3a4fe2d03 Mon Sep 17 00:00:00 2001 From: Chen Liu Date: Tue, 11 Feb 2014 22:28:38 -0800 Subject: [PATCH 0124/1051] update Ubuntu Python packaging docs link --- docs/shipping/packaging.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst index 6d4aa5b8f..d2757f049 100644 --- a/docs/shipping/packaging.rst +++ b/docs/shipping/packaging.rst @@ -99,12 +99,12 @@ One simple option for a personal PyPi server is to use Amazon S3. A prerequisite 6. **All done** -* You can now your package with :code:`pip install --index-url=http://your-s3-bucket/packages/simple/ YourPackage` +* You can now install your package with :code:`pip install --index-url=http://your-s3-bucket/packages/simple/ YourPackage` For Linux Distributions :::::::::::::::::::::::: -* `Ubuntu `_ +* `Ubuntu `_ * `Fedora `_ * `Debian `_ * `Arch `_ From 2f5ae1786e68013b4cb84b2b2d685d3c5321310d Mon Sep 17 00:00:00 2001 From: anatoly techtonik Date: Wed, 12 Feb 2014 12:12:36 +0300 Subject: [PATCH 0125/1051] Update make files with versions from Sphinx 1.2 --- docs/Makefile | 53 +++++++++++++++++++++++++++++-- docs/make.bat | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 137 insertions(+), 3 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d8dd1f433..5c60d189d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -7,12 +7,19 @@ SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @@ -27,14 +34,20 @@ help: @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: - -rm -rf $(BUILDDIR)/* + rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @@ -100,7 +113,13 @@ latex: latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: @@ -113,6 +132,24 @@ man: @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @@ -128,3 +165,13 @@ doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/make.bat b/docs/make.bat index 39f2a6893..d77abb0c0 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,8 +7,10 @@ if "%SPHINXBUILD%" == "" ( ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help @@ -28,7 +30,11 @@ if "%1" == "help" ( echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end @@ -40,8 +46,23 @@ if "%1" == "clean" ( goto end ) + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end @@ -49,6 +70,7 @@ if "%1" == "html" ( if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end @@ -56,6 +78,7 @@ if "%1" == "dirhtml" ( if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end @@ -63,6 +86,7 @@ if "%1" == "singlehtml" ( if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end @@ -70,6 +94,7 @@ if "%1" == "pickle" ( if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end @@ -77,6 +102,7 @@ if "%1" == "json" ( if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. @@ -85,6 +111,7 @@ if "%1" == "htmlhelp" ( if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: @@ -96,6 +123,7 @@ if "%1" == "qthelp" ( if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end @@ -103,6 +131,7 @@ if "%1" == "devhelp" ( if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end @@ -110,13 +139,35 @@ if "%1" == "epub" ( if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end @@ -124,13 +175,31 @@ if "%1" == "text" ( if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end @@ -138,6 +207,7 @@ if "%1" == "changes" ( if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. @@ -146,10 +216,27 @@ or in %BUILDDIR%/linkcheck/output.txt. if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + :end From ee36d451036b43501a3a76671e1dad6709ba2427 Mon Sep 17 00:00:00 2001 From: anatoly techtonik Date: Wed, 12 Feb 2014 12:18:28 +0300 Subject: [PATCH 0126/1051] Fix project name in generated files (osxpython -> pythonguide) --- docs/Makefile | 8 ++++---- docs/index.rst | 2 +- docs/make.bat | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 5c60d189d..40b479e94 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -85,17 +85,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/osxpython.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pythonguide.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/osxpython.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pythonguide.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/osxpython" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/osxpython" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pythonguide" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pythonguide" @echo "# devhelp" epub: diff --git a/docs/index.rst b/docs/index.rst index 19e167222..1779f2f35 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,4 @@ -.. osxpython documentation master file, created by +.. pythonguide documentation master file, created by sphinx-quickstart on Wed Aug 4 22:51:11 2010. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/docs/make.bat b/docs/make.bat index d77abb0c0..c2cdfb647 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -115,9 +115,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\osxpython.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pythonguide.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\osxpython.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pythonguide.ghc goto end ) From c0fc5c18f3819b33a9d05b1059fb062891adf41e Mon Sep 17 00:00:00 2001 From: anatoly techtonik Date: Wed, 12 Feb 2014 13:17:29 +0300 Subject: [PATCH 0127/1051] make.bat: Try Sphinx installed in Python when sphinx-build is not in PATH --- docs/make.bat | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/make.bat b/docs/make.bat index c2cdfb647..b1533bc50 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -47,6 +47,14 @@ if "%1" == "clean" ( ) +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 2> nul +if errorlevel 9009 goto sphinx_python +goto spinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. @@ -60,6 +68,9 @@ if errorlevel 9009 ( exit /b 1 ) +:sphinx_ok + + if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 From f9dc281c9d17c2139f599fd624d0d2edf7770f15 Mon Sep 17 00:00:00 2001 From: anatoly techtonik Date: Wed, 12 Feb 2014 13:41:55 +0300 Subject: [PATCH 0128/1051] Fix typo --- docs/make.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.bat b/docs/make.bat index b1533bc50..115651a00 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -50,7 +50,7 @@ if "%1" == "clean" ( REM Check if sphinx-build is available and fallback to Python version if any %SPHINXBUILD% 2> nul if errorlevel 9009 goto sphinx_python -goto spinx_ok +goto sphinx_ok :sphinx_python From 78f2b9e6ad6d44e461efad22cc9053a87f23e198 Mon Sep 17 00:00:00 2001 From: Chen Liu Date: Wed, 12 Feb 2014 09:03:21 -0800 Subject: [PATCH 0129/1051] expand "-" belongs to "Ansible" --- docs/scenarios/admin.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst index fd4645485..5fca65f94 100644 --- a/docs/scenarios/admin.rst +++ b/docs/scenarios/admin.rst @@ -177,7 +177,7 @@ A full terminal application like a widely extended top which is based on psutil monitoring is `glance `_. Ansible ----- +------- .. todo:: Write about Ansible From 6d2d731a9d6c106c5788c01e6658e5062bc37c31 Mon Sep 17 00:00:00 2001 From: Andy Visser Date: Wed, 12 Feb 2014 15:45:03 -0500 Subject: [PATCH 0130/1051] "where ever" => "wherever" --- docs/starting/install/osx.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst index 0f95e73bf..cada3bb33 100644 --- a/docs/starting/install/osx.rst +++ b/docs/starting/install/osx.rst @@ -96,7 +96,7 @@ habit of using it to create completely clean Python environments for each project. This is particularly important for Web development, where each framework and application will have many dependencies. -To set up a new Python environment, change the working directory to where ever +To set up a new Python environment, change the working directory to wherever you want to store the environment, and run the virtualenv utility in your project's directory From 29a3643ab485171cf4d3ede567628a4dbc91e9fd Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Sat, 15 Feb 2014 13:08:42 +0100 Subject: [PATCH 0131/1051] Cython example added for strong typing --- docs/scenarios/speed.rst | 118 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index 6aaa96bbd..af8f355bc 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -68,6 +68,124 @@ C Extensions Cython ------ +With `Cython `_ you are able to write C and C++ modules for Python. It implements a superset of the Python language. +With Cython you are also able to call C-functions and realize strong typing of variables and functions like float +(floating point numbers) or int (integer) definition of variables. Here is an example of strong typing with Cython: + +.. code-block:: python + + def primes(int kmax): + cdef int n, k, i + cdef int p[1000] + result = [] + if kmax > 1000: + kmax = 1000 + k = 0 + n = 2 + while k < kmax: + i = 0 + while i < k and n % p[i] != 0: + i = i + 1 + if i == k: + p[k] = n + k = k + 1 + result.append(n) + n = n + 1 + return result + +This implementation of an algorithm to find prime numbers has some additional commands instead of the next one, which is implemented in pure Python: + +.. code-block:: python + + def primes( kmax): + p= range(1000) + result = [] + if kmax > 1000: + kmax = 1000 + k = 0 + n = 2 + while k < kmax: + i = 0 + while i < k and n % p[i] != 0: + i = i + 1 + if i == k: + p[k] = n + k = k + 1 + result.append(n) + n = n + 1 + return result + + +The only difference between the both algorithm is this part: + +Strong typing with Cython: + +.. code-block:: python + + #primes function with additional Cython code: + def primes(int kmax): + cdef int n, k, i + cdef int p[1000] + result = [] + + +Normal variable definition in Python: + +.. code-block:: python + + #primes in standard Python syntax: + def primes( kmax): + p= range(1000) + result = [] + + +What is the difference? In the upper Cython version you can see the definitions of the variable types like in standard C. +For example `cdef int n,k,i` in line 3. This additional type definition (e.g. integer) allows the Cython compiler to generate +more efficient C code from this Cython code. While standard Python code is saved in `*.py` files, the Cython code is saved in `*.pyx` files. + +And what is with the speed? So lets try it! + +.. code-block:: python + + import time + #activate pyx compiler + import pyximport; pyximport.install() + #primes implemented with Cython + import primesCy + #primes implemented with Python + import primes + + print "Cython:" + t1= time.time() + print primesCy.primes(500) + t2= time.time() + print "Cython time: %s" %(t2-t1) + print "" + print "Python" + t1= time.time() + print primes.primes(500) + t2= time.time() + print "Python time: %s" %(t2-t1) + + +Where is the magic? Here it is: + +.. code-block:: python + + import pyximport; pyximport.install() + + +With the module `pyximport` you are able to import Cython `*.pyx` files, in this case `primesCy.pyx`, with the Cython +version of the primes function. +The `pyximport.install()` command allows the Python interpreter to start the Cython compiler directly to generate C-code, +which is automatically compiled to a `*.so` C-library. ... and Cython is able to import this library for you in your Python-code. +Very easy and very efficient. With the `time.time()` function you are able to compare the time between this 2 different calls to find 500 (!) prime numbers. + +Here is the output of an embedded `ARM beaglebone `_ machine: + +Cython time: 0.0196 seconds + +Python time: 0.3302 seconds Pyrex ----- From a30b491b5624a7be6f49352659ae18bc48c1c106 Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Sat, 15 Feb 2014 17:58:40 +0100 Subject: [PATCH 0132/1051] indentation fixed --- docs/scenarios/speed.rst | 84 ++++++++++++++++++++-------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index af8f355bc..505608630 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -74,46 +74,48 @@ With Cython you are also able to call C-functions and realize strong typing of v .. code-block:: python - def primes(int kmax): - cdef int n, k, i - cdef int p[1000] - result = [] - if kmax > 1000: - kmax = 1000 - k = 0 - n = 2 - while k < kmax: - i = 0 - while i < k and n % p[i] != 0: - i = i + 1 - if i == k: - p[k] = n - k = k + 1 - result.append(n) - n = n + 1 - return result + def primes(int kmax): + cdef int n, k, i + cdef int p[1000] + result = [] + if kmax > 1000: + kmax = 1000 + k = 0 + n = 2 + while k < kmax: + i = 0 + while i < k and n % p[i] != 0: + i = i + 1 + if i == k: + p[k] = n + k = k + 1 + result.append(n) + n = n + 1 + return result + This implementation of an algorithm to find prime numbers has some additional commands instead of the next one, which is implemented in pure Python: .. code-block:: python - def primes( kmax): - p= range(1000) - result = [] - if kmax > 1000: - kmax = 1000 - k = 0 - n = 2 - while k < kmax: - i = 0 - while i < k and n % p[i] != 0: - i = i + 1 - if i == k: - p[k] = n - k = k + 1 - result.append(n) - n = n + 1 - return result + def primes( kmax): + p= range(1000) + result = [] + if kmax > 1000: + kmax = 1000 + k = 0 + n = 2 + while k < kmax: + i = 0 + while i < k and n % p[i] != 0: + i = i + 1 + if i == k: + p[k] = n + k = k + 1 + result.append(n) + n = n + 1 + return result + The only difference between the both algorithm is this part: @@ -124,10 +126,9 @@ Strong typing with Cython: #primes function with additional Cython code: def primes(int kmax): - cdef int n, k, i - cdef int p[1000] - result = [] - + cdef int n, k, i + cdef int p[1000] + result = [] Normal variable definition in Python: @@ -135,9 +136,8 @@ Normal variable definition in Python: #primes in standard Python syntax: def primes( kmax): - p= range(1000) - result = [] - + p= range(1000) + result = [] What is the difference? In the upper Cython version you can see the definitions of the variable types like in standard C. For example `cdef int n,k,i` in line 3. This additional type definition (e.g. integer) allows the Cython compiler to generate From 7ef55e755f8c8e714ade2f1ebbf21ebab585e7dd Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Sat, 15 Feb 2014 18:38:43 +0100 Subject: [PATCH 0133/1051] minor changes (indentation fixed) --- docs/scenarios/speed.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index 505608630..f8a37c907 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -124,8 +124,8 @@ Strong typing with Cython: .. code-block:: python - #primes function with additional Cython code: - def primes(int kmax): + #primes function with additional Cython code: + def primes(int kmax): cdef int n, k, i cdef int p[1000] result = [] @@ -135,7 +135,7 @@ Normal variable definition in Python: .. code-block:: python #primes in standard Python syntax: - def primes( kmax): + def primes( kmax): p= range(1000) result = [] @@ -149,7 +149,8 @@ And what is with the speed? So lets try it! import time #activate pyx compiler - import pyximport; pyximport.install() + import pyximport + pyximport.install() #primes implemented with Cython import primesCy #primes implemented with Python @@ -172,14 +173,15 @@ Where is the magic? Here it is: .. code-block:: python - import pyximport; pyximport.install() + import pyximport + pyximport.install() With the module `pyximport` you are able to import Cython `*.pyx` files, in this case `primesCy.pyx`, with the Cython version of the primes function. The `pyximport.install()` command allows the Python interpreter to start the Cython compiler directly to generate C-code, which is automatically compiled to a `*.so` C-library. ... and Cython is able to import this library for you in your Python-code. -Very easy and very efficient. With the `time.time()` function you are able to compare the time between this 2 different calls to find 500 (!) prime numbers. +Very easy and very efficient. With the `time.time()` function you are able to compare the time between this 2 different calls to find 500 prime numbers. Here is the output of an embedded `ARM beaglebone `_ machine: From d30830009a5df0c10019ced46f036478dcdc5807 Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Sat, 15 Feb 2014 19:33:00 +0100 Subject: [PATCH 0134/1051] Cython: additional benchmark for standard CPU --- docs/scenarios/speed.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index f8a37c907..7a2ef88c4 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -183,7 +183,13 @@ The `pyximport.install()` command allows the Python interpreter to start the Cyt which is automatically compiled to a `*.so` C-library. ... and Cython is able to import this library for you in your Python-code. Very easy and very efficient. With the `time.time()` function you are able to compare the time between this 2 different calls to find 500 prime numbers. -Here is the output of an embedded `ARM beaglebone `_ machine: +On a standard notebook (dualcore AMD E-450 1,6 GHz) the measured values are: + +Cython time: 0.0054 seconds + +Python time: 0.0566 seconds + +And here the output of an embedded `ARM beaglebone `_ machine: Cython time: 0.0196 seconds From 33b428b8a5c352f9c6d902c352f3d477bb1f7bf2 Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Sun, 16 Feb 2014 17:50:07 +0100 Subject: [PATCH 0135/1051] misspelling in description --- docs/scenarios/speed.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index 7a2ef88c4..308d27c04 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -181,7 +181,7 @@ With the module `pyximport` you are able to import Cython `*.pyx` files, in this version of the primes function. The `pyximport.install()` command allows the Python interpreter to start the Cython compiler directly to generate C-code, which is automatically compiled to a `*.so` C-library. ... and Cython is able to import this library for you in your Python-code. -Very easy and very efficient. With the `time.time()` function you are able to compare the time between this 2 different calls to find 500 prime numbers. +Very easy and very efficient. With the `time.time()` function you are able to compare the time between these 2 different calls to find 500 prime numbers. On a standard notebook (dualcore AMD E-450 1,6 GHz) the measured values are: From 87ec12d320426076a23fe8886e5cba2205357623 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Gr=C3=B6ger?= Date: Mon, 17 Feb 2014 20:52:21 +0100 Subject: [PATCH 0136/1051] Included tldrlegal.com tl;drLegal is a great place to look up what a particular license is all about. The website can be found here: https://tldrlegal.com/ --- docs/writing/license.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/writing/license.rst b/docs/writing/license.rst index 6f0df77d2..1fbd09a8b 100644 --- a/docs/writing/license.rst +++ b/docs/writing/license.rst @@ -48,5 +48,5 @@ To help you choose one for your project, there's a `license chooser `_. From c8bda6892f7802763bb36b2e2512505a06c4d158 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Gr=C3=B6ger?= Date: Mon, 17 Feb 2014 21:03:36 +0100 Subject: [PATCH 0137/1051] Added oxford comma. --- docs/writing/license.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/writing/license.rst b/docs/writing/license.rst index 1fbd09a8b..9dd7c86d2 100644 --- a/docs/writing/license.rst +++ b/docs/writing/license.rst @@ -48,5 +48,5 @@ To help you choose one for your project, there's a `license chooser `_. +A good overview of licenses with explanations of what one can, cannot, and must do using a particular software can be found at `tl;drLegal `_. From 1be68ba74976dba31230432f672108b26af2d2d5 Mon Sep 17 00:00:00 2001 From: Dhia Abbassi Date: Wed, 19 Feb 2014 21:15:16 +0100 Subject: [PATCH 0138/1051] Update cli.rst Added Cliff module description. --- docs/scenarios/cli.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 5af149e75..217d06fea 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -28,3 +28,10 @@ rather than written down by imperatively. It is targetting especially unsophisti users, programmers, sys-admins, scientists and in general people writing throw-away scripts for themselves, choosing the command-line interface because it is quick and simple. + +Cliff +------ +`Cliff `_ is a framework for building command line programs. +It uses setuptools entry points to provide subcommands, output formatters, and other extensions. The framework +is meant to be used to create multi-level commands such as subversion and git, where the main program handles +some basic argument parsing and then invokes a sub-command to do the work. From c46965911652c00b7368423c59ecc4ea3a71d53d Mon Sep 17 00:00:00 2001 From: Dhia Abbassi Date: Thu, 20 Feb 2014 09:25:27 +0100 Subject: [PATCH 0139/1051] Update cli.rst Blank line added after the title Cliff. --- docs/scenarios/cli.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 217d06fea..cee4872d0 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -31,6 +31,7 @@ and simple. Cliff ------ + `Cliff `_ is a framework for building command line programs. It uses setuptools entry points to provide subcommands, output formatters, and other extensions. The framework is meant to be used to create multi-level commands such as subversion and git, where the main program handles From ca240c247921a47062d764f625c024d86b1c5b6f Mon Sep 17 00:00:00 2001 From: Jeff Hammerbacher Date: Sat, 22 Feb 2014 18:59:01 -0500 Subject: [PATCH 0140/1051] "faster on tracks" => "back on track faster" --- docs/writing/tests.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst index 4e8749161..05faace7b 100644 --- a/docs/writing/tests.rst +++ b/docs/writing/tests.rst @@ -40,7 +40,7 @@ Some general rules of testing: - If you are in the middle of a development session and have to interrupt your work, it is a good idea to write a broken unit test about what you want to develop next. When coming back to work, you will have a pointer to where you were and get - faster on tracks. + back on track faster. - The first step when you are debugging your code is to write a new test pinpointing the bug. While it is not always possible to do, those bug From b8f99234165cd520cdda5f2e440b6066492fa772 Mon Sep 17 00:00:00 2001 From: tommy3001 Date: Sun, 23 Feb 2014 23:32:13 +0100 Subject: [PATCH 0141/1051] Improvements of description. Thanks to sigmavirus24 --- docs/scenarios/speed.rst | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/docs/scenarios/speed.rst b/docs/scenarios/speed.rst index 308d27c04..05130c841 100644 --- a/docs/scenarios/speed.rst +++ b/docs/scenarios/speed.rst @@ -69,12 +69,14 @@ Cython ------ With `Cython `_ you are able to write C and C++ modules for Python. It implements a superset of the Python language. -With Cython you are also able to call C-functions and realize strong typing of variables and functions like float -(floating point numbers) or int (integer) definition of variables. Here is an example of strong typing with Cython: +You are also able to call C-functions and realize declaration of variables and functions like in C. Here is an example: .. code-block:: python def primes(int kmax): + """Calculation of prime numbers with additional + Cython keywords""" + cdef int n, k, i cdef int p[1000] result = [] @@ -94,11 +96,14 @@ With Cython you are also able to call C-functions and realize strong typing of v return result -This implementation of an algorithm to find prime numbers has some additional commands instead of the next one, which is implemented in pure Python: +This implementation of an algorithm to find prime numbers has some additional keywords instead of the next one, which is implemented in pure Python: .. code-block:: python - def primes( kmax): + + def primes(kmax): + """Calculation of prime numbers in standard Python syntax""" + p= range(1000) result = [] if kmax > 1000: @@ -120,28 +125,30 @@ This implementation of an algorithm to find prime numbers has some additional co The only difference between the both algorithm is this part: -Strong typing with Cython: .. code-block:: python - #primes function with additional Cython code: def primes(int kmax): + """Calculation of prime numbers with additional + Cython keywords""" + cdef int n, k, i cdef int p[1000] result = [] -Normal variable definition in Python: .. code-block:: python - #primes in standard Python syntax: - def primes( kmax): + def primes(kmax): + """Calculation of prime numbers in standard Python syntax""" + p= range(1000) result = [] -What is the difference? In the upper Cython version you can see the definitions of the variable types like in standard C. -For example `cdef int n,k,i` in line 3. This additional type definition (e.g. integer) allows the Cython compiler to generate -more efficient C code from this Cython code. While standard Python code is saved in `*.py` files, the Cython code is saved in `*.pyx` files. +What is the difference? In the upper Cython version you can see the declaration of the variable types and the integer array +in a similar way like in standard C. For example `cdef int n,k,i` in line 3. This additional type declaration (e.g. integer) +allows the Cython compiler to generate more efficient C code from the second code. While standard Python code is saved in `*.py` files, +Cython code is saved in `*.pyx` files. And what is with the speed? So lets try it! @@ -169,7 +176,7 @@ And what is with the speed? So lets try it! print "Python time: %s" %(t2-t1) -Where is the magic? Here it is: +These both lines need a remark: .. code-block:: python @@ -177,11 +184,10 @@ Where is the magic? Here it is: pyximport.install() -With the module `pyximport` you are able to import Cython `*.pyx` files, in this case `primesCy.pyx`, with the Cython -version of the primes function. +The `pyximport` module allows you to import `pyx` files (e.g., `primesCy.pyx`) with the Cython-compiled version of the `primes` function. The `pyximport.install()` command allows the Python interpreter to start the Cython compiler directly to generate C-code, -which is automatically compiled to a `*.so` C-library. ... and Cython is able to import this library for you in your Python-code. -Very easy and very efficient. With the `time.time()` function you are able to compare the time between these 2 different calls to find 500 prime numbers. +which is automatically compiled to a `*.so` C-library. Cython is able to import this library for you in your Python-code. +Very easy and very efficient. With the `time.time()` function you are able to compare the time between this 2 different calls to find 500 prime numbers. On a standard notebook (dualcore AMD E-450 1,6 GHz) the measured values are: From 8330e78359976140bea06ea3fde9425505d5c7c8 Mon Sep 17 00:00:00 2001 From: eet6646 Date: Sun, 23 Feb 2014 22:24:12 -0400 Subject: [PATCH 0142/1051] Issue #361 - Link to PDF --- docs/_templates/sidebarintro.html | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html index 58c71b058..096524c6a 100644 --- a/docs/_templates/sidebarintro.html +++ b/docs/_templates/sidebarintro.html @@ -31,4 +31,5 @@

Useful Links

From a2da09a6c594ce0ee4de9643ad0fdfa199a1588c Mon Sep 17 00:00:00 2001 From: eet6646 Date: Mon, 24 Feb 2014 15:07:24 -0400 Subject: [PATCH 0145/1051] Wording fix --- docs/_templates/sidebarintro.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html index 096524c6a..a8c525a0e 100644 --- a/docs/_templates/sidebarintro.html +++ b/docs/_templates/sidebarintro.html @@ -31,5 +31,5 @@

Useful Links