Changes between Version 3 and Version 4 of PythonGuidelines

Timestamp:

Mar 25, 2010 3:30:02 AM (13 years ago)

Author:

Chris Jerdonek

Comment:

Added Basics and Code Structure sub-sections

PythonGuidelines

@@ -3 +3 @@
 Here is an overview of WebKit's use of Python.
 
+== Basics ==
+
+ * Most of WebKit's Python scripts require Python 2.5 to run.
+ * Informally, we try to follow [http://www.python.org/dev/peps/pep-0008/ PEP8].  Eventually we may make this official.
+ * [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts/test-webkitpy Scripts/test-webkitpy] unit tests the Python code.
+
+== Code Structure ==
+
  * Most of the Python code is in [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts/webkitpy WebKitTools/Scripts/webkitpy]. 
- * [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts WebKitTools/Scripts] also contains some Python code in the form of end-user scripts.  Generally, we try to keep as much of the code in webkitpy as possible since this allows the code to be organized more nicely, for unit tests to be in companion files, etc.
+ * [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts WebKitTools/Scripts] also contains end-user Python scripts (which usually import from webkitpy).
+ * Generally, we try to keep as much of the Python code in webkitpy as possible since this allows the code to be organized more nicely (for unit tests to be in companion files, etc).
  * Unit test files are in correspondence with modules.  For example, if module.py is the name of a module, its unit test file would be module_unittest.py and would lie in the same directory.
- * Informally, we try to follow [http://www.python.org/dev/peps/pep-0008/ PEP8].
- * We put all third-party Python code in [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts/webkitpy webkitpy/thirdparty].
- * [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts/test-webkitpy Scripts/test-webkitpy] unit tests the Python code.
- * Most of WebKit's Python scripts require Python 2.5 to run.
+ * The root-level folders in webkitpy/ generally correspond to end-user scripts in WebKitTools/Scripts.  For example--
+  * check-webkit-style -> webkitpy/style/
+  * new-run-webkit-tests -> webkitpy/layout_tests/
+  * webkit-patch -> webkit/tool/
+ * Exceptions to the rule above are--
+  * webkitpy/common/: code shared by multiple root folders
+  * webkitpy/python24/: code that needs to work under Python 2.4 (currently just the version-checking code)
+  * [http://trac.webkit.org/browser/trunk/WebKitTools/Scripts/webkitpy webkitpy/thirdparty/]: all third-party code in webkitpy
 
 == Installing a new version of Python ==