Author: Carl Friedrich Bolz <cfb...@gmx.de>
Branch:
Changeset: r90859:762a7454ce1c
Date: 2017-03-29 13:26 +0200
http://bitbucket.org/pypy/pypy/changeset/762a7454ce1c/
Log: add docstrings to some of the __pypy__ function
diff --git a/pypy/module/__pypy__/__init__.py b/pypy/module/__pypy__/__init__.py
--- a/pypy/module/__pypy__/__init__.py
+++ b/pypy/module/__pypy__/__init__.py
@@ -6,6 +6,8 @@
class BuildersModule(MixedModule):
+ """ Module containing string and unicode builders """
+
appleveldefs = {}
interpleveldefs = {
@@ -34,6 +36,8 @@
class IntOpModule(MixedModule):
+ """ Module for integer operations that have two-complement overflow
+ behaviour instead of overflowing to longs """
appleveldefs = {}
interpleveldefs = {
'int_add': 'interp_intop.int_add',
@@ -55,6 +59,8 @@
class Module(MixedModule):
+ """ PyPy specific "magic" functions. A lot of them are experimental and
+ subject to change, many are internal. """
appleveldefs = {
}
diff --git a/pypy/module/__pypy__/interp_magic.py
b/pypy/module/__pypy__/interp_magic.py
--- a/pypy/module/__pypy__/interp_magic.py
+++ b/pypy/module/__pypy__/interp_magic.py
@@ -123,13 +123,15 @@
])
@unwrap_spec(sizehint=int)
-def resizelist_hint(space, w_iterable, sizehint):
- if not isinstance(w_iterable, W_ListObject):
+def resizelist_hint(space, w_list, sizehint):
+ """ Reallocate the underlying storage of the argument list to sizehint """
+ if not isinstance(w_list, W_ListObject):
raise oefmt(space.w_TypeError, "arg 1 must be a 'list'")
- w_iterable._resize_hint(sizehint)
+ w_list._resize_hint(sizehint)
@unwrap_spec(sizehint=int)
def newlist_hint(space, sizehint):
+ """ Create a new empty list that has an underlying storage of length
sizehint """
return space.newlist_hint(sizehint)
@unwrap_spec(debug=bool)
@@ -141,6 +143,9 @@
@unwrap_spec(estimate=int)
def add_memory_pressure(estimate):
+ """ Add memory pressure of estimate bytes. Useful when calling a C function
+ that internally allocates a big chunk of memory. This instructs the GC to
+ garbage collect sooner than it would otherwise."""
rgc.add_memory_pressure(estimate)
@unwrap_spec(w_frame=PyFrame)
_______________________________________________
pypy-commit mailing list
pypy-commit@python.org
https://mail.python.org/mailman/listinfo/pypy-commit
