Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 8b396b3

Browse filesBrowse files
sigmavirus24sigmavirus24
committed
Merge branch 'pr/659'
Fixes realpython#659
2 parents de12022 + 8ad4ec2 commit 8b396b3
Copy full SHA for 8b396b3

File tree

Expand file treeCollapse file tree

9 files changed

+139
-24
lines changed
Filter options
Expand file treeCollapse file tree

9 files changed

+139
-24
lines changed

‎docs/_templates/sidebarintro.html

Copy file name to clipboardExpand all lines: docs/_templates/sidebarintro.html
-10Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,6 @@ <h3>Get Updates</h3>
88

99
<p><a href="http://tinyletter.com/kennethreitz">Subscribe to Newsletter</a></p>
1010

11-
<h3>Donate</h3>
12-
<p>
13-
If you enjoy this guide, consider supporting the author <a href="https://www.gittip.com/kennethreitz/">on Gittip</a>:
14-
</p>
15-
<p>
16-
<iframe style="border: 0; margin: 0; padding: 0;"
17-
src="https://www.gittip.com/kennethreitz/widget.html"
18-
width="60pt" height="20pt"></iframe>
19-
</p>
20-
2111
<h3>Contributors</h3>
2212
<p>
2313
This guide is the result of the collaboration of

‎docs/_templates/sidebarlogo.html

Copy file name to clipboardExpand all lines: docs/_templates/sidebarlogo.html
-10Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,3 @@ <h3>Get Updates</h3>
77
<p>Receive updates on new releases and upcoming projects.</p>
88

99
<p><a href="http://tinyletter.com/kennethreitz">Subscribe to Newsletter</a></p>
10-
11-
<h3>Donate</h3>
12-
<p>
13-
If you enjoy this guide, consider supporting the author <a href="https://www.gittip.com/kennethreitz/">on Gittip</a>:
14-
</p>
15-
<p>
16-
<iframe style="border: 0; margin: 0; padding: 0;"
17-
src="https://www.gittip.com/kennethreitz/widget.html"
18-
width="60pt" height="20pt"></iframe>
19-
</p>

‎docs/contents.rst.inc

Copy file name to clipboardExpand all lines: docs/contents.rst.inc
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ different scenarios.
6363
scenarios/xml
6464
scenarios/json
6565
scenarios/crypto
66+
scenarios/clibs
6667

6768

6869
Shipping Great Code

‎docs/dev/virtualenvs.rst

Copy file name to clipboardExpand all lines: docs/dev/virtualenvs.rst
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _virtualenvironments-ref:
2+
13
Virtual Environments
24
====================
35

‎docs/scenarios/clibs.rst

Copy file name to clipboard
+129Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
Interfacing with C/C++ Libraries
2+
================================
3+
4+
C Foreign Function Interface
5+
----------------------------
6+
7+
`CFFI <https://cffi.readthedocs.org/en/latest/>`_ provides a simple to use
8+
mechanism for interfacing with C from both CPython and PyPy. It supports two
9+
modes: an inline ABI compatibility mode (example provided below), which allows
10+
you to dynamically load and run functions from executable modules (essentially
11+
exposing the same functionality as LoadLibrary or dlopen), and an API mode,
12+
which allows you to build C extension modules.
13+
14+
ABI Interaction
15+
~~~~~~~~~~~~~~~
16+
17+
.. code-block:: python
18+
:linenos:
19+
20+
from cffi import FFI
21+
ffi = FFI()
22+
ffi.cdef("size_t strlen(const char*);")
23+
clib = ffi.dlopen(None)
24+
length = clib.strlen("String to be evaluated.")
25+
# prints: 23
26+
print("{}".format(length))
27+
28+
ctypes
29+
------
30+
31+
`ctypes <https://docs.python.org/3/library/ctypes.html>`_ is the de facto
32+
library for interfacing with C/C++ from CPython, and it provides not only
33+
full access to the native C interface of most major operating systems (e.g.,
34+
kernel32 on Windows, or libc on \*nix), but also provides support for loading
35+
and interfacing with dynamic libraries, such as DLLs or shared objects at
36+
runtime. It does bring along with it a whole host of types for interacting
37+
with system APIs, and allows you to rather easily define your own complex
38+
types, such as structs and unions, and allows you to modify things such as
39+
padding and alignment, if needed. It can be a bit crufty to use, but in
40+
conjunction with the `struct <https://docs.python.org/3.5/library/struct.html>`_
41+
module, you are essentially provided full control over how your data types get
42+
translated into something something usable by a pure C(++) method.
43+
44+
Struct Equivalents
45+
~~~~~~~~~~~~~~~~~~
46+
47+
:file:`MyStruct.h`
48+
49+
.. code-block:: c
50+
:linenos:
51+
52+
struct my_struct {
53+
int a;
54+
int b;
55+
};
56+
57+
:file:`MyStruct.py`
58+
59+
.. code-block:: python
60+
:linenos:
61+
62+
import ctypes
63+
class my_struct(ctypes.Structure):
64+
_fields_ = [("a", c_int),
65+
("b", c_int)]
66+
67+
SWIG
68+
----
69+
70+
`SWIG <http://www.swig.org>`_, though not strictly Python focused (it supports a
71+
large number of scripting languages), is a tool for generating bindings for
72+
interpreted languages from C/C++ header files. It is extremely simple to use:
73+
the consumer simply needs to define an interface file (detailed in the
74+
tutorial and documentations), include the requisite C/C++ headers, and run
75+
the build tool against them. While it does have some limits, (it currently
76+
seems to have issues with a small subset of newer C++ features, and getting
77+
template-heavy code to work can be a bit verbose), it provides a great deal
78+
of power and exposes lots of features to Python with little effort.
79+
Additionally, you can easily extend the bindings SWIG creates (in the
80+
interface file) to overload operators and built-in methods, effectively re-
81+
cast C++ exceptions to be catchable by Python, etc.
82+
83+
Example: Overloading __repr__
84+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85+
86+
:file:`MyClass.h`
87+
88+
.. code-block:: c++
89+
:linenos:
90+
91+
#include <string>
92+
class MyClass {
93+
private:
94+
std::string name;
95+
public:
96+
std::string getName();
97+
};
98+
99+
:file:`myclass.i`
100+
101+
.. code-block:: c++
102+
:linenos:
103+
104+
%include "string.i"
105+
106+
%module myclass
107+
%{
108+
#include <string>
109+
#include "MyClass.h"
110+
%}
111+
112+
%extend MyClass {
113+
std::string __repr__()
114+
{
115+
return $self->getName();
116+
}
117+
}
118+
119+
%include "MyClass.h"
120+
121+
122+
Boost.Python
123+
------------
124+
125+
`Boost.Python <http://www.boost.org/doc/libs/1_59_0/libs/python/doc/>`_
126+
requires a bit more manual work to expose C++ object functionality, but
127+
it is capable of providing all the same features SWIG does and then some,
128+
to include providing wrappers to access PyObjects in C++, extracting SWIG-
129+
wrapper objects, and even embedding bits of Python into your C++ code.

‎docs/scenarios/scrape.rst

Copy file name to clipboardExpand all lines: docs/scenarios/scrape.rst
+4-1Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ parse it using the ``html`` module and save the results in ``tree``:
3838
.. code-block:: python
3939
4040
page = requests.get('http://econpy.pythonanywhere.com/ex/001.html')
41-
tree = html.fromstring(page.text)
41+
tree = html.fromstring(page.content)
42+
43+
(We need to use ``page.content`` rather than ``page.text`` because
44+
``html.fromstring`` implicitly expects ``bytes`` as input.)
4245

4346
``tree`` now contains the whole HTML file in a nice tree structure which
4447
we can go over two different ways: XPath and CSSSelect. In this example, we

‎docs/starting/install/linux.rst

Copy file name to clipboardExpand all lines: docs/starting/install/linux.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ your global site-packages directory clean and manageable.
5858
For example, you can work on a project which requires Django 1.3 while also
5959
maintaining a project which requires Django 1.0.
6060

61-
To start using and see more information: `Virtual Environments <http://github.com/kennethreitz/python-guide/blob/master/docs/dev/virtualenvs.rst>`_ docs.
61+
To start using this and see more information: :ref:`Virtual Environments <virtualenvironments-ref>` docs.
6262

6363
You can also use :ref:`virtualenvwrapper <virtualenvwrapper-ref>` to make it easier to
6464
manage your virtual environments.

‎docs/starting/install/osx.rst

Copy file name to clipboardExpand all lines: docs/starting/install/osx.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ your global site-packages directory clean and manageable.
9292
For example, you can work on a project which requires Django 1.3 while also
9393
maintaining a project which requires Django 1.0.
9494

95-
To start using and see more information: `Virtual Environments <http://github.com/kennethreitz/python-guide/blob/master/docs/dev/virtualenvs.rst>`_ docs.
95+
To start using this and see more information: :ref:`Virtual Environments <virtualenvironments-ref>` docs.
9696

9797

9898
--------------------------------

‎docs/starting/install/win.rst

Copy file name to clipboardExpand all lines: docs/starting/install/win.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ your global site-packages directory clean and manageable.
7777
For example, you can work on a project which requires Django 1.3 while also
7878
maintaining a project which requires Django 1.0.
7979

80-
To start using and see more information: `Virtual Environments <http://github.com/kennethreitz/python-guide/blob/master/docs/dev/virtualenvs.rst>`_ docs.
80+
To start using this and see more information: :ref:`Virtual Environments <virtualenvironments-ref>` docs.
8181

8282

8383
--------------------------------

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.