mirror of
https://github.com/kennethreitz/tablib.git
synced 2026-06-05 15:00:19 +00:00
Compare commits
519 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9146de36d4 | |||
| 9761ff5e9e | |||
| e5259cbb58 | |||
| 56ef89424f | |||
| 4a01299293 | |||
| 9399bf2fe7 | |||
| cbdaa09e83 | |||
| f30e760657 | |||
| a60e2f132e | |||
| 2b36d71554 | |||
| 690de63b7c | |||
| 6b6ef70c61 | |||
| 322283b8f9 | |||
| 3968729903 | |||
| 7b1e533e39 | |||
| 8dd7d73abc | |||
| 176c9615d6 | |||
| c65fd4201f | |||
| 11bca4f7a2 | |||
| 2b5818598a | |||
| 79fb82d69d | |||
| 5350355fbe | |||
| 85673b365c | |||
| 87ce64d4c8 | |||
| 2cd381389c | |||
| 35f21cf73e | |||
| 0ebc8f5e1b | |||
| 865ce62782 | |||
| 3b961c59e7 | |||
| 4be341be4f | |||
| 2c4337b317 | |||
| 0e4128c73e | |||
| 4ebd66cb09 | |||
| bfcfa37ebb | |||
| 5c50c1822e | |||
| 2e5577ee91 | |||
| 84e4bd9a47 | |||
| 7270ce49e1 | |||
| c3052cc02c | |||
| 999c49a4f0 | |||
| 59c996f9df | |||
| a2b62669b7 | |||
| 15e25ef735 | |||
| 7ae7d3ff46 | |||
| 69ed718191 | |||
| 328d3880d5 | |||
| ea3cc847a0 | |||
| 8efab51355 | |||
| e42d215833 | |||
| 10bc5549c9 | |||
| 1a5e2ecb33 | |||
| e1bf189847 | |||
| 0785328e21 | |||
| 6ba0cc9af3 | |||
| 36876205e7 | |||
| 1b97b7191e | |||
| 8b575df419 | |||
| 6a3928759a | |||
| 63348d883b | |||
| 5dce600969 | |||
| 0913b54f47 | |||
| c5bbc74b96 | |||
| 7f5342a1b8 | |||
| d42f9bc10f | |||
| c6565c9e29 | |||
| 1a9343750e | |||
| 8a393214c8 | |||
| b8ed741a36 | |||
| cddbd78a61 | |||
| b113f49ce6 | |||
| 1429b9f8c4 | |||
| 42700f98a5 | |||
| 0e56db632a | |||
| b07512071e | |||
| e4881809d6 | |||
| 54ab300d2d | |||
| 4368d64317 | |||
| 117344de14 | |||
| 58bc1c7dcf | |||
| 4c8b5e72e3 | |||
| b900236157 | |||
| dc14a16e04 | |||
| 2d2ac9b708 | |||
| 1efcb7a63d | |||
| 65c73dfc42 | |||
| 3803a7a21b | |||
| 8b5b29fc90 | |||
| e8ba765426 | |||
| 57001a5465 | |||
| c8493ff047 | |||
| 03914323c2 | |||
| 2f331cee8e | |||
| e1734f2315 | |||
| 22cddbcd63 | |||
| 76f09cd3b3 | |||
| d11c09febe | |||
| 9ab277a468 | |||
| 23c1831144 | |||
| 1cf9bd14b4 | |||
| c2331f7a23 | |||
| bccf0d1ba1 | |||
| c219972ccd | |||
| 52e9d44739 | |||
| e94ecd8472 | |||
| 96067e6380 | |||
| 1cc0f7d1f4 | |||
| f685bf548e | |||
| ca336926da | |||
| 1aa3d3b06a | |||
| be576135b2 | |||
| 0c05d0497e | |||
| 52e307ea35 | |||
| 5cac9bd97e | |||
| a285e993f1 | |||
| 0ed367a31c | |||
| c4815c24cc | |||
| 20fe1e0153 | |||
| 5db8d1c3a6 | |||
| 828017f9a7 | |||
| cff8a6ac9a | |||
| aa8590e8b8 | |||
| d2de647c47 | |||
| 7afef680f5 | |||
| 35763f8c24 | |||
| cc3d020914 | |||
| b8b5405f1c | |||
| b7aebbc74f | |||
| d776d78df5 | |||
| 6f9365d376 | |||
| 621b1bd45c | |||
| be21b6fadd | |||
| 832bfbbb1b | |||
| 288b15fb54 | |||
| 73df22303b | |||
| 4c125bd206 | |||
| ff0de1377a | |||
| ccb29c68fa | |||
| e077a7f2bc | |||
| dcc52bdc18 | |||
| 9cac54eefc | |||
| f69a96f07e | |||
| ca77ed6f64 | |||
| 806aba9ef3 | |||
| 23cbc0c333 | |||
| 34ab54de77 | |||
| 0843a15879 | |||
| 08ed309382 | |||
| 26b6faa88d | |||
| 140736ff33 | |||
| 5379c5683d | |||
| e8b44b5777 | |||
| a0822bc9b0 | |||
| 89b431213b | |||
| 695e8c5af7 | |||
| 0797ec67d4 | |||
| 1852624a7e | |||
| f81dc41a57 | |||
| 34415b89b8 | |||
| d25655588b | |||
| 22c4d185e1 | |||
| e3b3659ea4 | |||
| 22d337790a | |||
| 0784d4b32c | |||
| 332c5bccd9 | |||
| 7055d18a2e | |||
| 6a7c685111 | |||
| 0e5b8f7058 | |||
| e3e6b656e3 | |||
| 99896a5f28 | |||
| 25da44f569 | |||
| 7727171379 | |||
| 91bd4eb9c7 | |||
| 9b74b139fd | |||
| 823a543f41 | |||
| 1aa275bf99 | |||
| 17bb0d3b2c | |||
| 1a9aee9289 | |||
| 196edb82cc | |||
| a2990d5852 | |||
| d992ece86a | |||
| 46f302255d | |||
| 9e3ab4c13f | |||
| eaed0e48c2 | |||
| 501187b357 | |||
| ea4aef88b6 | |||
| 24d800fac3 | |||
| d8136ab613 | |||
| 36bbe2726b | |||
| 1427be2901 | |||
| 10ce000d31 | |||
| a91254117c | |||
| b67762604f | |||
| 83a8346e8f | |||
| 657ab98d04 | |||
| 9ddb4de942 | |||
| 5fad80a540 | |||
| cabab73045 | |||
| 2bb0525990 | |||
| f364bb576e | |||
| 09d057094e | |||
| 8082c4ad43 | |||
| 00e9ae0120 | |||
| f01c22213e | |||
| a58bf269d9 | |||
| 437a135dd3 | |||
| 0409ff50af | |||
| dd24edcc24 | |||
| cf28f4baa8 | |||
| 52dcf79c41 | |||
| 49f098ee22 | |||
| 642b1d8def | |||
| f6964bba8f | |||
| 8d6e75ad20 | |||
| 30487999ba | |||
| b74308e81e | |||
| 577289cbc3 | |||
| cf10703e31 | |||
| 778ad0265e | |||
| e3dedb8887 | |||
| c6e240fa52 | |||
| 5c747c9c2e | |||
| 0bbd990ed8 | |||
| fcada243a2 | |||
| fca8ad6182 | |||
| 35d9e390fd | |||
| 8ca180c461 | |||
| ff63558a67 | |||
| f621b56178 | |||
| 2b529bcb1c | |||
| 90c3435600 | |||
| 1fa28ee2ca | |||
| a5cae7c249 | |||
| 666991ca1e | |||
| 5f4162918f | |||
| b554ce36bb | |||
| e5e22d3ca2 | |||
| 8626351618 | |||
| cdfacb6d6e | |||
| 108c9de130 | |||
| 271aeebf56 | |||
| e75a00541d | |||
| 3b0e0c7991 | |||
| 23440fb7a3 | |||
| 459f310857 | |||
| f9021f53c2 | |||
| 7fda829d27 | |||
| ca08ac8a7b | |||
| 08b51113d3 | |||
| 3e391fc8e3 | |||
| a230844914 | |||
| bc82be09c5 | |||
| ed9fe01604 | |||
| e69546a0ff | |||
| d4b659ece9 | |||
| 55eb3f93e3 | |||
| be7182aea9 | |||
| 48def2cba6 | |||
| df8c0335d1 | |||
| d0b09f0fce | |||
| 9efd982bfa | |||
| a3c82804cd | |||
| 2e75e93f57 | |||
| a26d782e88 | |||
| f5c0c5c34d | |||
| d9aee8e605 | |||
| 315a082b70 | |||
| 120ce9fcd6 | |||
| 914a82eac9 | |||
| 3931bcb4e6 | |||
| 471e56c387 | |||
| 8553dbc040 | |||
| 96c93871cf | |||
| a54949bc08 | |||
| ed686c2391 | |||
| 143677be77 | |||
| b2c35c2543 | |||
| 9dfd9d0c8e | |||
| 140e23c980 | |||
| ac797f1eda | |||
| 7c90595364 | |||
| 38ac98fdb2 | |||
| 07c7d172d9 | |||
| 9c7707be60 | |||
| 14bee65208 | |||
| 4fc5e0655d | |||
| da2e670d0d | |||
| 5912bf4870 | |||
| 28e9d7e23e | |||
| 930d38cf5a | |||
| 5e433c263d | |||
| 19ac9b9716 | |||
| 6feb59504a | |||
| 817eedd6f5 | |||
| 4d1c5a9996 | |||
| 520a1986d7 | |||
| 1ea793112c | |||
| 41a7a5d329 | |||
| c4edaa2ca8 | |||
| c612bb3dae | |||
| c223dfbdf1 | |||
| 49bd48b016 | |||
| c6d90bc825 | |||
| bcd0e37a65 | |||
| 8c92e878a3 | |||
| da2b011358 | |||
| a8b0bf4b5f | |||
| 6574d3e58b | |||
| 1020799828 | |||
| 333e73f892 | |||
| bfe70066b8 | |||
| fbfbe01b70 | |||
| 06a394ea5c | |||
| 9427decdb0 | |||
| fb59035f8d | |||
| 187d12cffc | |||
| eaa4de7793 | |||
| d479c5735a | |||
| 96668bb393 | |||
| b369baba40 | |||
| 25f846a78a | |||
| 22fe18239f | |||
| 149bafa97b | |||
| 9f7fec2379 | |||
| 762ac39e27 | |||
| 2a7aa959b3 | |||
| d85523b6a6 | |||
| 6407afba3e | |||
| 25a5bcea0c | |||
| 7aada68952 | |||
| 5ba92b0f6b | |||
| f58d4b67dc | |||
| a310ab7a09 | |||
| 7f2f925ddb | |||
| 3fc898e222 | |||
| de46f45e2e | |||
| 392eaac299 | |||
| 3a9c3944cf | |||
| 8c402da729 | |||
| 8feb6e8ddf | |||
| 9072b6ddae | |||
| 9f26c23eb5 | |||
| 8136f4b09e | |||
| 7e7ad73ddd | |||
| f889910629 | |||
| 969d9d957d | |||
| 86d84b555d | |||
| 66867527d2 | |||
| 7505d8d985 | |||
| d5515c17b8 | |||
| 07ac723971 | |||
| 5d7843ea59 | |||
| b5f0cf9d37 | |||
| a73bbe1645 | |||
| f1bdf43aab | |||
| 7623bfe7b0 | |||
| 59ccc0b422 | |||
| 99154aa6d6 | |||
| 65836d5ace | |||
| 4117503ed5 | |||
| dfa26a7d53 | |||
| 4f035caf1b | |||
| a9c7a5067d | |||
| 80cb42e8dd | |||
| 8d7e5732cd | |||
| 942dd3dadf | |||
| b1d282744c | |||
| 4c0c879d65 | |||
| cab63e02c8 | |||
| 63d025888a | |||
| 5a993ac281 | |||
| 666dd1d2c7 | |||
| ac1666e3ae | |||
| 5b7e817db2 | |||
| f9c168e4bc | |||
| 82f3d84c7d | |||
| 121cf46aec | |||
| 4bb4a05bcb | |||
| e52b8dd329 | |||
| 93fb89b8b6 | |||
| c01b66a16a | |||
| c3fa29a166 | |||
| 8d6a52aaf5 | |||
| 703b1da04c | |||
| 0e6bd079cc | |||
| 579dbf0cc0 | |||
| fbabb430ca | |||
| b8f923f8c5 | |||
| fbe6fe1612 | |||
| 17e90e71e5 | |||
| dc21825f34 | |||
| 7364995eaa | |||
| 3407170b99 | |||
| dd13744c92 | |||
| 31e4c39762 | |||
| 4fc70957ac | |||
| 7f17ccf445 | |||
| fbcc3b60af | |||
| 9b3268f0ad | |||
| f386ef8ac8 | |||
| e8f5e023c4 | |||
| 81445aeec8 | |||
| f94a236122 | |||
| bfbb7c626f | |||
| be0f77f9ee | |||
| 3b44349090 | |||
| 04a16afa58 | |||
| a8632125dc | |||
| ccf2ebcde2 | |||
| 2c60ce9233 | |||
| 649c7e8bb7 | |||
| 2d3dc5ef71 | |||
| efc516f366 | |||
| b2a51fd941 | |||
| d54d70bc22 | |||
| 391ad61bef | |||
| 99a45814d1 | |||
| fad3546614 | |||
| 7ba2849829 | |||
| 7ec0f2ef07 | |||
| bd470684a4 | |||
| dbcea81c17 | |||
| 49dc4a249e | |||
| 7cd82f956f | |||
| 13c3e537fd | |||
| f913853cae | |||
| ea1de420a3 | |||
| d0c8df95a3 | |||
| bb4e97f8aa | |||
| ffaeb64639 | |||
| f31ec562b4 | |||
| 68d7204b2d | |||
| 52db1ddc3e | |||
| 4755020dd7 | |||
| 5468dd7e67 | |||
| 8673710ddb | |||
| f01cf184d4 | |||
| 1482ca4a19 | |||
| 93c6c39581 | |||
| a0cb44cc43 | |||
| b2cd061773 | |||
| 876b849950 | |||
| 40c9e09578 | |||
| 9f5379fcc7 | |||
| 9ecc57dbf7 | |||
| a7471f7302 | |||
| 70211b71e0 | |||
| ddf4b441b0 | |||
| a0509126e0 | |||
| ec5b1cf3e0 | |||
| 3fb729aac6 | |||
| 647f69044f | |||
| 3da34af76f | |||
| 5b42824871 | |||
| 89209b6bd3 | |||
| 9362d3283b | |||
| 123851a737 | |||
| 54973c276c | |||
| 275ac9d194 | |||
| 4ecd5888af | |||
| 359f12c83c | |||
| de8d76fdae | |||
| f188e3dd87 | |||
| 3dff8f5b79 | |||
| c24d2dd45d | |||
| 4e98563483 | |||
| ca17c9f965 | |||
| 41c4fcc59f | |||
| e9166b14fd | |||
| a5528d731e | |||
| 1a122f2a4d | |||
| e9d9350e43 | |||
| ac4b568cba | |||
| 8be372b8cc | |||
| f8d8d3058a | |||
| d03ba7e532 | |||
| 35102ab951 | |||
| b8587e5cb0 | |||
| da4f2013f1 | |||
| ff069b1604 | |||
| 2994a9fc0d | |||
| 310400af5b | |||
| d52537b75b | |||
| 40490d1ba5 | |||
| 9f025dc111 | |||
| 335e3b1134 | |||
| 6b4afc38d1 | |||
| bd3099897c | |||
| 4b6fbe9225 | |||
| f22357f1bc | |||
| 37ffbc71c0 | |||
| 6f7c64eb03 | |||
| 89be8f402f | |||
| 607ea4a8aa | |||
| 7044896d56 | |||
| 8fca234388 | |||
| 0862b35905 | |||
| e8bf07da1a | |||
| 5c70fe0a07 | |||
| 6c37412c76 | |||
| 54a83602e4 | |||
| f486b77a7a | |||
| fecfecfd16 | |||
| 9a65b8deed | |||
| 61231b38ac | |||
| b7a8b65c00 | |||
| 6dd71c8830 | |||
| 8d44ad8a12 | |||
| 1850a934aa | |||
| ee953512b7 | |||
| 6405ec3baf | |||
| ea64e4cfac | |||
| 0bea48ccc3 | |||
| 687670762f | |||
| 254ce62b2a | |||
| 2b3f277138 | |||
| a2f59584e4 | |||
| 4d3a31e19f | |||
| 95c98861da | |||
| 59d1f9fded |
+12
-2
@@ -1,10 +1,11 @@
|
||||
# application builds
|
||||
build/*
|
||||
dist/*
|
||||
MANIFEST
|
||||
|
||||
# python skin
|
||||
.pyc
|
||||
.pyo
|
||||
*.pyc
|
||||
*.pyo
|
||||
|
||||
# osx noise
|
||||
.DS_Store
|
||||
@@ -13,3 +14,12 @@ profile
|
||||
# pycharm noise
|
||||
.idea
|
||||
.idea/*
|
||||
|
||||
# vi noise
|
||||
*.swp
|
||||
docs/_build/*
|
||||
coverage.xml
|
||||
nosetests.xml
|
||||
junit-py25.xml
|
||||
junit-py26.xml
|
||||
junit-py27.xml
|
||||
@@ -1,13 +1,18 @@
|
||||
GistAPI.py is written and maintained by Kenneth Reitz and
|
||||
Tablib is written and maintained by Kenneth Reitz and
|
||||
various contributors:
|
||||
|
||||
Development Lead
|
||||
````````````````
|
||||
|
||||
- Kenneth Reitz <me@kennethreitz.com>
|
||||
- Kenneth Reitz <_@kennethreitz.com>
|
||||
|
||||
|
||||
Patches and Suggestions
|
||||
```````````````````````
|
||||
|
||||
- A Lucky Someone
|
||||
- Luke Lee
|
||||
- Josh Ourisman
|
||||
- Luca Beltrame
|
||||
- Benjamin Wohlwend
|
||||
- Erik Youngren
|
||||
- Mark Rogers
|
||||
@@ -0,0 +1,14 @@
|
||||
Where possible, please follow PEP8 with regard to coding style. Sometimes the line
|
||||
length restriction is too hard to follow, so don't bend over backwards there.
|
||||
|
||||
Triple-quotes should always be """, single quotes are ' unless using "
|
||||
would result in less escaping within the string.
|
||||
|
||||
All modules, functions, and methods should be well documented reStructuredText for
|
||||
Sphinx AutoDoc.
|
||||
|
||||
All functionality should be available in pure Python. Optional C (via Cython)
|
||||
implementations may be written for performance reasons, but should never
|
||||
replace the Python implementation.
|
||||
|
||||
Lastly, don't take yourself too seriously :)
|
||||
+160
@@ -0,0 +1,160 @@
|
||||
History
|
||||
-------
|
||||
|
||||
0.9.7 (2011-05-12)
|
||||
++++++++++++++++++
|
||||
|
||||
* Full XLSX Support!
|
||||
* Pickling Bugfix
|
||||
* Compat Module
|
||||
|
||||
|
||||
0.9.6 (2011-05-12)
|
||||
++++++++++++++++++
|
||||
|
||||
* ``seperators`` renamed to ``separators``
|
||||
* Full unicode CSV support
|
||||
|
||||
|
||||
0.9.5 (2011-03-24)
|
||||
++++++++++++++++++
|
||||
|
||||
* Python 3.1, Python 3.2 Support (same code base!)
|
||||
* Formatter callback support
|
||||
* Various bug fixes
|
||||
|
||||
|
||||
|
||||
0.9.4 (2011-02-18)
|
||||
++++++++++++++++++
|
||||
|
||||
* Python 2.5 Support!
|
||||
* Tox Testing for 2.5, 2.6, 2.7
|
||||
* AnyJSON Integrated
|
||||
* OrderedDict support
|
||||
* Caved to community pressure (spaces)
|
||||
|
||||
|
||||
0.9.3 (2011-01-31)
|
||||
++++++++++++++++++
|
||||
|
||||
* Databook duplication leak fix.
|
||||
* HTML Table output.
|
||||
* Added column sorting.
|
||||
|
||||
|
||||
0.9.2 (2010-11-17)
|
||||
++++++++++++++++++
|
||||
|
||||
* Transpose method added to Datasets.
|
||||
* New frozen top row in Excel output.
|
||||
* Pickling support for Datasets and Rows.
|
||||
* Support for row/column stacking.
|
||||
|
||||
|
||||
0.9.1 (2010-11-04)
|
||||
++++++++++++++++++
|
||||
|
||||
* Minor reference shadowing bugfix.
|
||||
|
||||
|
||||
0.9.0 (2010-11-04)
|
||||
++++++++++++++++++
|
||||
|
||||
* Massive documentation update!
|
||||
* Tablib.org!
|
||||
* Row tagging and Dataset filtering!
|
||||
* Column insert/delete support
|
||||
* Column append API change (header required)
|
||||
* Internal Changes (Row object and use thereof)
|
||||
|
||||
|
||||
0.8.5 (2010-10-06)
|
||||
++++++++++++++++++
|
||||
|
||||
* New import system. All dependencies attempt to load from site-packages,
|
||||
then fallback on tenderized modules.
|
||||
|
||||
|
||||
0.8.4 (2010-10-04)
|
||||
++++++++++++++++++
|
||||
|
||||
* Updated XLS output: Only wrap if '\\n' in cell.
|
||||
|
||||
|
||||
0.8.3 (2010-10-04)
|
||||
++++++++++++++++++
|
||||
|
||||
* Ability to append new column passing a callable
|
||||
as the value that will be applied to every row.
|
||||
|
||||
|
||||
0.8.2 (2010-10-04)
|
||||
++++++++++++++++++
|
||||
|
||||
* Added alignment wrapping to written cells.
|
||||
* Added separator support to XLS.
|
||||
|
||||
|
||||
0.8.1 (2010-09-28)
|
||||
++++++++++++++++++
|
||||
|
||||
* Packaging Fix
|
||||
|
||||
|
||||
0.8.0 (2010-09-25)
|
||||
++++++++++++++++++
|
||||
|
||||
* New format plugin system!
|
||||
* Imports! ELEGANT Imports!
|
||||
* Tests. Lots of tests.
|
||||
|
||||
|
||||
0.7.1 (2010-09-20)
|
||||
++++++++++++++++++
|
||||
|
||||
* Reverting methods back to properties.
|
||||
* Windows bug compensated in documentation.
|
||||
|
||||
|
||||
0.7.0 (2010-09-20)
|
||||
++++++++++++++++++
|
||||
|
||||
* Renamed DataBook Databook for consistency.
|
||||
* Export properties changed to methods (XLS filename / StringIO bug).
|
||||
* Optional Dataset.xls(path='filename') support (for writing on windows).
|
||||
* Added utf-8 on the worksheet level.
|
||||
|
||||
|
||||
0.6.4 (2010-09-19)
|
||||
++++++++++++++++++
|
||||
|
||||
* Updated unicode export for XLS.
|
||||
* More exhaustive unit tests.
|
||||
|
||||
|
||||
0.6.3 (2010-09-14)
|
||||
++++++++++++++++++
|
||||
* Added Dataset.append() support for columns.
|
||||
|
||||
|
||||
0.6.2 (2010-09-13)
|
||||
++++++++++++++++++
|
||||
* Fixed Dataset.append() error on empty dataset.
|
||||
* Updated Dataset.headers property w/ validation.
|
||||
* Added Testing Fixtures.
|
||||
|
||||
0.6.1 (2010-09-12)
|
||||
++++++++++++++++++
|
||||
|
||||
* Packaging hotfixes.
|
||||
|
||||
|
||||
0.6.0 (2010-09-11)
|
||||
++++++++++++++++++
|
||||
|
||||
* Public Release.
|
||||
* Export Support for XLS, JSON, YAML, and CSV.
|
||||
* DataBook Export for XLS, JSON, and YAML.
|
||||
* Python Dict Property Support.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Copyright (c) 2010 Kenneth Reitz.
|
||||
Copyright (c) 2011 Kenneth Reitz.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
+1
-1
@@ -1 +1 @@
|
||||
include HISTORY.rst README.rst tabbed
|
||||
include HISTORY.rst README.rst LICENSE AUTHORS
|
||||
@@ -0,0 +1,209 @@
|
||||
Tablib includes some vendorized python libraries: ordereddict, pyyaml,
|
||||
simplejson, unicodecsv, and xlwt.
|
||||
|
||||
Markup License
|
||||
==============
|
||||
|
||||
Markup is in the public domain.
|
||||
|
||||
|
||||
|
||||
OrderedDict License
|
||||
===================
|
||||
|
||||
Copyright (c) 2009 Raymond Hettinger
|
||||
|
||||
Permission is hereby granted, free of charge, to any person
|
||||
obtaining a copy of this software and associated documentation files
|
||||
(the "Software"), to deal in the Software without restriction,
|
||||
including without limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of the Software,
|
||||
and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
|
||||
PyYAML License
|
||||
==============
|
||||
|
||||
Copyright (c) 2006 Kirill Simonov
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
|
||||
|
||||
AnyJSON License
|
||||
==================
|
||||
|
||||
This software is licensed under the ``New BSD License``:
|
||||
|
||||
Copyright (c) 2009, by the authors
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
Neither the name of the authors nor the names of its contributors may be used
|
||||
to endorse or promote products derived from this software without specific
|
||||
prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
|
||||
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
UnicodeCSV License
|
||||
==================
|
||||
|
||||
Copyright 2010 Jeremy Dunck. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are
|
||||
permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||
of conditions and the following disclaimer in the documentation and/or other materials
|
||||
provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY JEREMY DUNCK ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
||||
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
||||
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JEREMY DUNCK OR
|
||||
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
The views and conclusions contained in the software and documentation are those of the
|
||||
authors and should not be interpreted as representing official policies, either expressed
|
||||
or implied, of Jeremy Dunck.
|
||||
|
||||
|
||||
|
||||
|
||||
XLWT License
|
||||
============
|
||||
|
||||
Portions copyright © 2007, Stephen John Machin, Lingfo Pty Ltd
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. None of the names of Stephen John Machin, Lingfo Pty Ltd and any
|
||||
contributors may be used to endorse or promote products derived from this
|
||||
software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
|
||||
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
||||
THE POSSIBILITY OF SUCH DAMAGE.
|
||||
"""
|
||||
|
||||
"""
|
||||
Copyright (C) 2005 Roman V. Kiseliov
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
3. All advertising materials mentioning features or use of this
|
||||
software must display the following acknowledgment:
|
||||
"This product includes software developed by
|
||||
Roman V. Kiseliov <roman@kiseliov.ru>."
|
||||
|
||||
4. Redistributions of any form whatsoever must retain the following
|
||||
acknowledgment:
|
||||
"This product includes software developed by
|
||||
Roman V. Kiseliov <roman@kiseliov.ru>."
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY Roman V. Kiseliov ``AS IS'' AND ANY
|
||||
EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Roman V. Kiseliov OR
|
||||
ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||||
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
||||
OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
Roman V. Kiseliov
|
||||
Russia
|
||||
Kursk
|
||||
Libknecht St., 4
|
||||
|
||||
+7(0712)56-09-83
|
||||
|
||||
<roman@kiseliov.ru>
|
||||
Subject: pyExcelerator
|
||||
+121
-63
@@ -1,97 +1,155 @@
|
||||
Tabbed: format-agnostic tabular dataset library
|
||||
Tablib: format-agnostic tabular dataset library
|
||||
===============================================
|
||||
|
||||
::
|
||||
|
||||
_____ ______ ______ _________
|
||||
__ /_______ ____ /_ ___ /_ _____ ______ /
|
||||
_ __/_ __ `/__ __ \__ __ \_ _ \_ __ /
|
||||
/ /_ / /_/ / _ /_/ /_ /_/ // __// /_/ /
|
||||
\__/ \__,_/ /_.___/ /_.___/ \___/ \__,_/
|
||||
|
||||
*Tabbed is under active documentation-driven development.*
|
||||
_____ ______ ___________ ______
|
||||
__ /_______ ____ /_ ___ /___(_)___ /_
|
||||
_ __/_ __ `/__ __ \__ / __ / __ __ \
|
||||
/ /_ / /_/ / _ /_/ /_ / _ / _ /_/ /
|
||||
\__/ \__,_/ /_.___/ /_/ /_/ /_.___/
|
||||
|
||||
|
||||
Tabbed is a format-agnostic tabular dataset library, written in Python.
|
||||
It is a full python module which doubles as a CLI application for quick
|
||||
dataset conversions.
|
||||
|
||||
Formats supported:
|
||||
Tablib is a format-agnostic tabular dataset library, written in Python.
|
||||
|
||||
- JSON
|
||||
- YAML
|
||||
- Excel
|
||||
- CSV
|
||||
- HTML
|
||||
Output formats supported:
|
||||
|
||||
Please note that tabbed *purposefully* excludes XML support. It always will.
|
||||
- Excel (Sets + Books)
|
||||
- JSON (Sets + Books)
|
||||
- YAML (Sets + Books)
|
||||
- HTML (Sets)
|
||||
- TSV (Sets)
|
||||
- CSV (Sets)
|
||||
|
||||
Note that tablib *purposefully* excludes XML support. It always will. (Note: This is a joke. Pull requests are welcome.)
|
||||
|
||||
Features
|
||||
Overview
|
||||
--------
|
||||
|
||||
Convert datafile formats via API: ::
|
||||
`tablib.Dataset()`
|
||||
A Dataset is a table of tabular data. It may or may not have a header row. They can be build and manipulated as raw Python datatypes (Lists of tuples|dictionaries). Datasets can be imported from JSON, YAML, and CSV; they can be exported to Excel (XLS), JSON, YAML, and CSV.
|
||||
|
||||
tablib.import(filename='data.csv').export('data.json')
|
||||
`tablib.Databook()`
|
||||
A Databook is a set of Datasets. The most common form of a Databook is an Excel file with multiple spreadsheets. Databooks can be imported from JSON and YAML; they can be exported to Excel (XLS), JSON, and YAML.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
|
||||
Convert datafile formats via CLI: ::
|
||||
|
||||
$ tabbed data.csv data.json
|
||||
|
||||
Convert data formats via CLI pipe interface: ::
|
||||
|
||||
$ curl http://domain.dev/dataset.json | tabbed --to excel | gist -p
|
||||
|
||||
|
||||
Populate fresh data files: ::
|
||||
|
||||
headers = ('first_name', 'last_name', 'gpa')
|
||||
|
||||
headers = ('first_name', 'last_name')
|
||||
|
||||
data = [
|
||||
('John', 'Adams', 4.0),
|
||||
('George', 'Washington', 2.6),
|
||||
('Henry', 'Ford', 2.3)
|
||||
('John', 'Adams'),
|
||||
('George', 'Washington')
|
||||
]
|
||||
|
||||
data = tablib.Data(*data, headers=headers)
|
||||
|
||||
# Establish file location and save
|
||||
data.save('test.xls')
|
||||
|
||||
data = tablib.Dataset(*data, headers=headers)
|
||||
|
||||
|
||||
Intelligently add new rows: ::
|
||||
|
||||
data.add_row('Bob', 'Dylan')
|
||||
# >>> Warning: Existing column count is 3
|
||||
|
||||
print data.headers
|
||||
# >>> ('first_name', 'last_name', 'gpa')
|
||||
|
||||
>>> data.append(('Henry', 'Ford'))
|
||||
|
||||
Intelligently add new columns: ::
|
||||
|
||||
>>> data.append(col=(90, 67, 83), header='age')
|
||||
|
||||
Slice rows: ::
|
||||
|
||||
print data[0:1]
|
||||
# >>> [('John', 'Adams', 4.0), ('George', 'Washington', 2.6)]
|
||||
|
||||
>>> print data[:2]
|
||||
[('John', 'Adams', 90), ('George', 'Washington', 67)]
|
||||
|
||||
|
||||
Slice columns by header: ::
|
||||
|
||||
print data['first_name']
|
||||
# >>> ['John', 'George', 'Henry']
|
||||
|
||||
>>> print data['first_name']
|
||||
['John', 'George', 'Henry']
|
||||
|
||||
Manipulate rows by index: ::
|
||||
Easily delete rows: ::
|
||||
|
||||
data.delRow(0)
|
||||
print data[0:1]
|
||||
# >>> [('George', 'Washington', 2.6), ('Henry', 'Ford', 2.3)]
|
||||
|
||||
# Update saved file
|
||||
data.save()
|
||||
|
||||
>>> del data[1]
|
||||
|
||||
Export to various formats: ::
|
||||
Exports
|
||||
-------
|
||||
|
||||
# Save copy as CSV
|
||||
data.export('backup.csv')
|
||||
Drumroll please...........
|
||||
|
||||
JSON!
|
||||
+++++
|
||||
::
|
||||
|
||||
>>> print data.json
|
||||
[
|
||||
{
|
||||
"last_name": "Adams",
|
||||
"age": 90,
|
||||
"first_name": "John"
|
||||
},
|
||||
{
|
||||
"last_name": "Ford",
|
||||
"age": 83,
|
||||
"first_name": "Henry"
|
||||
}
|
||||
]
|
||||
|
||||
|
||||
YAML!
|
||||
+++++
|
||||
::
|
||||
|
||||
>>> print data.yaml
|
||||
- {age: 90, first_name: John, last_name: Adams}
|
||||
- {age: 83, first_name: Henry, last_name: Ford}
|
||||
|
||||
CSV...
|
||||
++++++
|
||||
::
|
||||
|
||||
>>> print data.csv
|
||||
first_name,last_name,age
|
||||
John,Adams,90
|
||||
Henry,Ford,83
|
||||
|
||||
EXCEL!
|
||||
++++++
|
||||
::
|
||||
|
||||
>>> open('people.xls', 'wb').write(data.xls)
|
||||
|
||||
It's that easy.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
To install tablib, simply: ::
|
||||
|
||||
$ pip install tablib
|
||||
|
||||
Or, if you absolutely must: ::
|
||||
|
||||
$ easy_install tablib
|
||||
|
||||
Contribute
|
||||
----------
|
||||
|
||||
If you'd like to contribute, simply fork `the repository`_, commit your
|
||||
changes to the **develop** branch (or branch off of it), and send a pull
|
||||
request. Make sure you add yourself to AUTHORS_.
|
||||
|
||||
|
||||
Roadmap
|
||||
-------
|
||||
|
||||
v1.0.0:
|
||||
- Add hooks system
|
||||
- Tablib.ext namespace
|
||||
- Better 2.x/3.x handling (currently internal codebase fork)
|
||||
- Width detection on XLS out
|
||||
|
||||
|
||||
.. _`the repository`: http://github.com/kennethreitz/tablib
|
||||
.. _AUTHORS: http://github.com/kennethreitz/tablib/blob/master/AUTHORS
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
* Hooks System
|
||||
- pre/post-append
|
||||
- pre/post-import
|
||||
- pre/post-export
|
||||
* Add Tablib.ext namespace
|
||||
* Fix 2.x/3.x handling (currently internal codebase fork)
|
||||
* Make CSV write more customizable.
|
||||
* Width detection for XLS output
|
||||
* Documentation Improvements
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@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 " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@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)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Tablib.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Tablib.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/Tablib"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Tablib"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
make -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
@@ -0,0 +1,3 @@
|
||||
*.pyc
|
||||
*.pyo
|
||||
.DS_Store
|
||||
Vendored
+45
@@ -0,0 +1,45 @@
|
||||
Modifications:
|
||||
|
||||
Copyright (c) 2011 Kenneth Reitz.
|
||||
|
||||
|
||||
Original Project:
|
||||
|
||||
Copyright (c) 2010 by Armin Ronacher.
|
||||
|
||||
|
||||
Some rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms of the theme, with or
|
||||
without modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following
|
||||
disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.
|
||||
|
||||
* The names of the contributors may not be used to endorse or
|
||||
promote products derived from this software without specific
|
||||
prior written permission.
|
||||
|
||||
We kindly ask you to only use these themes in an unmodified manner just
|
||||
for Flask and Flask-related products, not for unrelated projects. If you
|
||||
like the visual style and want to use it for your own projects, please
|
||||
consider making some larger changes to the themes (such as changing
|
||||
font faces, sizes, colors or margins).
|
||||
|
||||
THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
Vendored
+25
@@ -0,0 +1,25 @@
|
||||
krTheme Sphinx Style
|
||||
====================
|
||||
|
||||
This repository contains sphinx styles Kenneth Reitz uses in most of
|
||||
his projects. It is a drivative of Mitsuhiko's themes for Flask and Flask related
|
||||
projects. To use this style in your Sphinx documentation, follow
|
||||
this guide:
|
||||
|
||||
1. put this folder as _themes into your docs folder. Alternatively
|
||||
you can also use git submodules to check out the contents there.
|
||||
|
||||
2. add this to your conf.py: ::
|
||||
|
||||
sys.path.append(os.path.abspath('_themes'))
|
||||
html_theme_path = ['_themes']
|
||||
html_theme = 'flask'
|
||||
|
||||
The following themes exist:
|
||||
|
||||
**kr**
|
||||
the standard flask documentation theme for large projects
|
||||
|
||||
**kr_small**
|
||||
small one-page theme. Intended to be used by very small addon libraries.
|
||||
|
||||
Vendored
+86
@@ -0,0 +1,86 @@
|
||||
# flasky extensions. flasky pygments style based on tango style
|
||||
from pygments.style import Style
|
||||
from pygments.token import Keyword, Name, Comment, String, Error, \
|
||||
Number, Operator, Generic, Whitespace, Punctuation, Other, Literal
|
||||
|
||||
|
||||
class FlaskyStyle(Style):
|
||||
background_color = "#f8f8f8"
|
||||
default_style = ""
|
||||
|
||||
styles = {
|
||||
# No corresponding class for the following:
|
||||
#Text: "", # class: ''
|
||||
Whitespace: "underline #f8f8f8", # class: 'w'
|
||||
Error: "#a40000 border:#ef2929", # class: 'err'
|
||||
Other: "#000000", # class 'x'
|
||||
|
||||
Comment: "italic #8f5902", # class: 'c'
|
||||
Comment.Preproc: "noitalic", # class: 'cp'
|
||||
|
||||
Keyword: "bold #004461", # class: 'k'
|
||||
Keyword.Constant: "bold #004461", # class: 'kc'
|
||||
Keyword.Declaration: "bold #004461", # class: 'kd'
|
||||
Keyword.Namespace: "bold #004461", # class: 'kn'
|
||||
Keyword.Pseudo: "bold #004461", # class: 'kp'
|
||||
Keyword.Reserved: "bold #004461", # class: 'kr'
|
||||
Keyword.Type: "bold #004461", # class: 'kt'
|
||||
|
||||
Operator: "#582800", # class: 'o'
|
||||
Operator.Word: "bold #004461", # class: 'ow' - like keywords
|
||||
|
||||
Punctuation: "bold #000000", # class: 'p'
|
||||
|
||||
# because special names such as Name.Class, Name.Function, etc.
|
||||
# are not recognized as such later in the parsing, we choose them
|
||||
# to look the same as ordinary variables.
|
||||
Name: "#000000", # class: 'n'
|
||||
Name.Attribute: "#c4a000", # class: 'na' - to be revised
|
||||
Name.Builtin: "#004461", # class: 'nb'
|
||||
Name.Builtin.Pseudo: "#3465a4", # class: 'bp'
|
||||
Name.Class: "#000000", # class: 'nc' - to be revised
|
||||
Name.Constant: "#000000", # class: 'no' - to be revised
|
||||
Name.Decorator: "#888", # class: 'nd' - to be revised
|
||||
Name.Entity: "#ce5c00", # class: 'ni'
|
||||
Name.Exception: "bold #cc0000", # class: 'ne'
|
||||
Name.Function: "#000000", # class: 'nf'
|
||||
Name.Property: "#000000", # class: 'py'
|
||||
Name.Label: "#f57900", # class: 'nl'
|
||||
Name.Namespace: "#000000", # class: 'nn' - to be revised
|
||||
Name.Other: "#000000", # class: 'nx'
|
||||
Name.Tag: "bold #004461", # class: 'nt' - like a keyword
|
||||
Name.Variable: "#000000", # class: 'nv' - to be revised
|
||||
Name.Variable.Class: "#000000", # class: 'vc' - to be revised
|
||||
Name.Variable.Global: "#000000", # class: 'vg' - to be revised
|
||||
Name.Variable.Instance: "#000000", # class: 'vi' - to be revised
|
||||
|
||||
Number: "#990000", # class: 'm'
|
||||
|
||||
Literal: "#000000", # class: 'l'
|
||||
Literal.Date: "#000000", # class: 'ld'
|
||||
|
||||
String: "#4e9a06", # class: 's'
|
||||
String.Backtick: "#4e9a06", # class: 'sb'
|
||||
String.Char: "#4e9a06", # class: 'sc'
|
||||
String.Doc: "italic #8f5902", # class: 'sd' - like a comment
|
||||
String.Double: "#4e9a06", # class: 's2'
|
||||
String.Escape: "#4e9a06", # class: 'se'
|
||||
String.Heredoc: "#4e9a06", # class: 'sh'
|
||||
String.Interpol: "#4e9a06", # class: 'si'
|
||||
String.Other: "#4e9a06", # class: 'sx'
|
||||
String.Regex: "#4e9a06", # class: 'sr'
|
||||
String.Single: "#4e9a06", # class: 's1'
|
||||
String.Symbol: "#4e9a06", # class: 'ss'
|
||||
|
||||
Generic: "#000000", # class: 'g'
|
||||
Generic.Deleted: "#a40000", # class: 'gd'
|
||||
Generic.Emph: "italic #000000", # class: 'ge'
|
||||
Generic.Error: "#ef2929", # class: 'gr'
|
||||
Generic.Heading: "bold #000080", # class: 'gh'
|
||||
Generic.Inserted: "#00A000", # class: 'gi'
|
||||
Generic.Output: "#888", # class: 'go'
|
||||
Generic.Prompt: "#745334", # class: 'gp'
|
||||
Generic.Strong: "bold #000000", # class: 'gs'
|
||||
Generic.Subheading: "bold #800080", # class: 'gu'
|
||||
Generic.Traceback: "bold #a40000", # class: 'gt'
|
||||
}
|
||||
Vendored
+31
@@ -0,0 +1,31 @@
|
||||
{%- extends "basic/layout.html" %}
|
||||
{%- block extrahead %}
|
||||
{{ super() }}
|
||||
{% if theme_touch_icon %}
|
||||
<link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
|
||||
{% endif %}
|
||||
<link media="only screen and (max-device-width: 480px)" href="{{
|
||||
pathto('_static/small_flask.css', 1) }}" type= "text/css" rel="stylesheet" />
|
||||
{% endblock %}
|
||||
{%- block relbar2 %}{% endblock %}
|
||||
{%- block footer %}
|
||||
<div class="footer">
|
||||
© Copyright {{ copyright }}.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', 'UA-8742933-9']);
|
||||
_gaq.push(['_setDomainName', 'none']);
|
||||
_gaq.push(['_setAllowLinker', true]);
|
||||
_gaq.push(['_trackPageview']);
|
||||
|
||||
(function() {
|
||||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||||
})();
|
||||
|
||||
</script>
|
||||
{%- endblock %}
|
||||
Vendored
+19
@@ -0,0 +1,19 @@
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul>
|
||||
{%- for parent in parents %}
|
||||
<li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul>
|
||||
{%- endfor %}
|
||||
{%- if prev %}
|
||||
<li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
|
||||
}}">{{ prev.title }}</a></li>
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter')
|
||||
}}">{{ next.title }}</a></li>
|
||||
{%- endif %}
|
||||
{%- for parent in parents %}
|
||||
</ul></li>
|
||||
{%- endfor %}
|
||||
</ul></li>
|
||||
</ul>
|
||||
Vendored
+430
@@ -0,0 +1,430 @@
|
||||
/*
|
||||
* flasky.css_t
|
||||
* ~~~~~~~~~~~~
|
||||
*
|
||||
* :copyright: Copyright 2010 by Armin Ronacher. Modifications by Kenneth Reitz.
|
||||
* :license: Flask Design License, see LICENSE for details.
|
||||
*/
|
||||
|
||||
{% set page_width = '940px' %}
|
||||
{% set sidebar_width = '220px' %}
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro';
|
||||
font-size: 17px;
|
||||
background-color: white;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: {{ page_width }};
|
||||
margin: 30px auto 0 auto;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 {{ sidebar_width }};
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
width: {{ sidebar_width }};
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #B1B4B6;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #3E4349;
|
||||
padding: 0 30px 0 30px;
|
||||
}
|
||||
|
||||
img.floatingflask {
|
||||
padding: 0 0 10px 10px;
|
||||
float: right;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
width: {{ page_width }};
|
||||
margin: 20px auto 30px auto;
|
||||
font-size: 14px;
|
||||
color: #888;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #888;
|
||||
}
|
||||
|
||||
div.related {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a:hover {
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
font-size: 14px;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 18px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.logo {
|
||||
padding: 0 0 20px 0;
|
||||
margin: 0;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3,
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
color: #444;
|
||||
font-size: 24px;
|
||||
font-weight: normal;
|
||||
margin: 0 0 5px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo a,
|
||||
div.sphinxsidebar h3 a,
|
||||
div.sphinxsidebar p.logo a:hover,
|
||||
div.sphinxsidebar h3 a:hover {
|
||||
border: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #555;
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px 0;
|
||||
padding: 0;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #ccc;
|
||||
font-family: 'Georgia', serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #004B6B;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #6D4100;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
margin: 30px 0px 10px 0px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
|
||||
div.body h2 { font-size: 180%; }
|
||||
div.body h3 { font-size: 150%; }
|
||||
div.body h4 { font-size: 130%; }
|
||||
div.body h5 { font-size: 100%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #ddd;
|
||||
padding: 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #444;
|
||||
background: #eaeaea;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
line-height: 1.4em;
|
||||
}
|
||||
|
||||
div.admonition {
|
||||
background: #fafafa;
|
||||
margin: 20px -30px;
|
||||
padding: 10px 30px;
|
||||
border-top: 1px solid #ccc;
|
||||
border-bottom: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.admonition tt.xref, div.admonition a tt {
|
||||
border-bottom: 1px solid #fafafa;
|
||||
}
|
||||
|
||||
dd div.admonition {
|
||||
margin-left: -60px;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
font-size: 24px;
|
||||
margin: 0 0 10px 0;
|
||||
padding: 0;
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
div.admonition p.last {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.highlight {
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background: #FAF3E8;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre, tt {
|
||||
font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
}
|
||||
|
||||
tt.descname, tt.descclassname {
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
tt.descname {
|
||||
padding-right: 0.08em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils {
|
||||
border: 1px solid #888;
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
border: 1px solid #888;
|
||||
padding: 0.25em 0.7em;
|
||||
}
|
||||
|
||||
table.field-list, table.footnote {
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
table.footnote {
|
||||
margin: 15px 0;
|
||||
width: 100%;
|
||||
border: 1px solid #eee;
|
||||
background: #fdfdfd;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
table.footnote + table.footnote {
|
||||
margin-top: -15px;
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
table.field-list th {
|
||||
padding: 0 0.8em 0 0;
|
||||
}
|
||||
|
||||
table.field-list td {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.footnote td.label {
|
||||
width: 0px;
|
||||
padding: 0.3em 0 0.3em 0.5em;
|
||||
}
|
||||
|
||||
table.footnote td {
|
||||
padding: 0.3em 0.5em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: 0 0 0 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
margin: 10px 0 10px 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: #eee;
|
||||
padding: 7px 30px;
|
||||
margin: 15px -30px;
|
||||
line-height: 1.3em;
|
||||
}
|
||||
|
||||
dl pre, blockquote pre, li pre {
|
||||
margin-left: -60px;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
dl dl pre {
|
||||
margin-left: -90px;
|
||||
padding-left: 90px;
|
||||
}
|
||||
|
||||
tt {
|
||||
background-color: #ecf0f3;
|
||||
color: #222;
|
||||
/* padding: 1px 2px; */
|
||||
}
|
||||
|
||||
tt.xref, a tt {
|
||||
background-color: #FBFBFB;
|
||||
border-bottom: 1px solid white;
|
||||
}
|
||||
|
||||
a.reference {
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a.footnote-reference {
|
||||
text-decoration: none;
|
||||
font-size: 0.7em;
|
||||
vertical-align: top;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.footnote-reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a:hover tt {
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
|
||||
@media screen and (max-width: 600px) {
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
margin-left: 0;
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
/*
|
||||
* small_flask.css_t
|
||||
* ~~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* :copyright: Copyright 2010 by Armin Ronacher.
|
||||
* :license: Flask Design License, see LICENSE for details.
|
||||
*/
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 20px 30px;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: none;
|
||||
background: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: block;
|
||||
float: none;
|
||||
width: 102.5%;
|
||||
margin: 50px -30px -20px -30px;
|
||||
padding: 10px 20px;
|
||||
background: #333;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
|
||||
div.sphinxsidebar h3 a {
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.related {
|
||||
display: block;
|
||||
margin: 0;
|
||||
padding: 10px 0 20px 0;
|
||||
}
|
||||
|
||||
div.related ul,
|
||||
div.related ul li {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.body {
|
||||
min-height: 0;
|
||||
padding: 0;
|
||||
}
|
||||
Vendored
+7
@@ -0,0 +1,7 @@
|
||||
[theme]
|
||||
inherit = basic
|
||||
stylesheet = flasky.css
|
||||
pygments_style = flask_theme_support.FlaskyStyle
|
||||
|
||||
[options]
|
||||
touch_icon =
|
||||
Vendored
+22
@@ -0,0 +1,22 @@
|
||||
{% extends "basic/layout.html" %}
|
||||
{% block header %}
|
||||
{{ super() }}
|
||||
{% if pagename == 'index' %}
|
||||
<div class=indexwrapper>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% block footer %}
|
||||
{% if pagename == 'index' %}
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{# do not display relbars #}
|
||||
{% block relbar1 %}{% endblock %}
|
||||
{% block relbar2 %}
|
||||
{% if theme_github_fork %}
|
||||
<a href="http://github.com/{{ theme_github_fork }}"><img style="position: fixed; top: 0; right: 0; border: 0;"
|
||||
src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% block sidebar1 %}{% endblock %}
|
||||
{% block sidebar2 %}{% endblock %}
|
||||
+287
@@ -0,0 +1,287 @@
|
||||
/*
|
||||
* flasky.css_t
|
||||
* ~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- flasky theme based on nature theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: 'Georgia', serif;
|
||||
font-size: 17px;
|
||||
color: #000;
|
||||
background: white;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 40px auto 0 auto;
|
||||
width: 700px;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #B1B4B6;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #3E4349;
|
||||
padding: 0 30px 30px 30px;
|
||||
}
|
||||
|
||||
img.floatingflask {
|
||||
padding: 0 0 10px 10px;
|
||||
float: right;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
text-align: right;
|
||||
color: #888;
|
||||
padding: 10px;
|
||||
font-size: 14px;
|
||||
width: 650px;
|
||||
margin: 0 auto 40px auto;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #888;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.related {
|
||||
line-height: 32px;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
padding: 0 0 0 10px;
|
||||
}
|
||||
|
||||
div.related a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #004B6B;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #6D4100;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body {
|
||||
padding-bottom: 40px; /* saved for footer */
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
margin: 30px 0px 10px 0px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
{% if theme_index_logo %}
|
||||
div.indexwrapper h1 {
|
||||
text-indent: -999999px;
|
||||
background: url({{ theme_index_logo }}) no-repeat center center;
|
||||
height: {{ theme_index_logo_height }};
|
||||
}
|
||||
{% endif %}
|
||||
|
||||
div.body h2 { font-size: 180%; }
|
||||
div.body h3 { font-size: 150%; }
|
||||
div.body h4 { font-size: 130%; }
|
||||
div.body h5 { font-size: 100%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: white;
|
||||
padding: 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #444;
|
||||
background: #eaeaea;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
line-height: 1.4em;
|
||||
}
|
||||
|
||||
div.admonition {
|
||||
background: #fafafa;
|
||||
margin: 20px -30px;
|
||||
padding: 10px 30px;
|
||||
border-top: 1px solid #ccc;
|
||||
border-bottom: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
font-size: 24px;
|
||||
margin: 0 0 10px 0;
|
||||
padding: 0;
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
div.admonition p.last {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.highlight{
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background: #FAF3E8;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
background-color: #ffe4e4;
|
||||
border: 1px solid #f66;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre, tt {
|
||||
font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
}
|
||||
|
||||
tt.descname, tt.descclassname {
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
tt.descname {
|
||||
padding-right: 0.08em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils {
|
||||
border: 1px solid #888;
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
border: 1px solid #888;
|
||||
padding: 0.25em 0.7em;
|
||||
}
|
||||
|
||||
table.field-list, table.footnote {
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
table.footnote {
|
||||
margin: 15px 0;
|
||||
width: 100%;
|
||||
border: 1px solid #eee;
|
||||
}
|
||||
|
||||
table.field-list th {
|
||||
padding: 0 0.8em 0 0;
|
||||
}
|
||||
|
||||
table.field-list td {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.footnote td {
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 0;
|
||||
margin: 15px -30px;
|
||||
padding: 8px;
|
||||
line-height: 1.3em;
|
||||
padding: 7px 30px;
|
||||
background: #eee;
|
||||
border-radius: 2px;
|
||||
-moz-border-radius: 2px;
|
||||
-webkit-border-radius: 2px;
|
||||
}
|
||||
|
||||
dl pre {
|
||||
margin-left: -60px;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
tt {
|
||||
background-color: #ecf0f3;
|
||||
color: #222;
|
||||
/* padding: 1px 2px; */
|
||||
}
|
||||
|
||||
tt.xref, a tt {
|
||||
background-color: #FBFBFB;
|
||||
}
|
||||
|
||||
a:hover tt {
|
||||
background: #EEE;
|
||||
}
|
||||
Vendored
+10
@@ -0,0 +1,10 @@
|
||||
[theme]
|
||||
inherit = basic
|
||||
stylesheet = flasky.css
|
||||
nosidebar = true
|
||||
pygments_style = flask_theme_support.FlaskyStyle
|
||||
|
||||
[options]
|
||||
index_logo = ''
|
||||
index_logo_height = 120px
|
||||
github_fork = ''
|
||||
@@ -0,0 +1,64 @@
|
||||
.. _api:
|
||||
|
||||
===
|
||||
API
|
||||
===
|
||||
|
||||
|
||||
.. module:: tablib
|
||||
|
||||
This part of the documentation covers all the interfaces of Tablib. For
|
||||
parts where Tablib depends on external libraries, we document the most
|
||||
important right here and provide links to the canonical documentation.
|
||||
|
||||
|
||||
--------------
|
||||
Dataset Object
|
||||
--------------
|
||||
|
||||
|
||||
.. autoclass:: Dataset
|
||||
:inherited-members:
|
||||
|
||||
|
||||
---------------
|
||||
Databook Object
|
||||
---------------
|
||||
|
||||
|
||||
.. autoclass:: Databook
|
||||
:inherited-members:
|
||||
|
||||
|
||||
|
||||
---------
|
||||
Functions
|
||||
---------
|
||||
|
||||
|
||||
.. autofunction:: detect
|
||||
|
||||
.. autofunction:: import_set
|
||||
|
||||
|
||||
----------
|
||||
Exceptions
|
||||
----------
|
||||
|
||||
|
||||
.. class:: InvalidDatasetType
|
||||
|
||||
You're trying to add something that doesn't quite look right.
|
||||
|
||||
|
||||
.. class:: InvalidDimensions
|
||||
|
||||
You're trying to add something that doesn't quite fit right.
|
||||
|
||||
|
||||
.. class:: UnsupportedFormat
|
||||
|
||||
You're trying to add something that doesn't quite taste right.
|
||||
|
||||
|
||||
Now, go start some :ref:`Tablib Development <development>`.
|
||||
+234
@@ -0,0 +1,234 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Tablib documentation build configuration file, created by
|
||||
# sphinx-quickstart on Tue Oct 5 15:25:21 2010.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys, os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
import tablib
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Tablib'
|
||||
copyright = u'2011, Kenneth Reitz. Styles (modified) © Armin Ronacher'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '0.9.7'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = version
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'flask_theme_support.FlaskyStyle'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['static']
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
html_show_sphinx = False
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Tablibdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
# The paper size ('letter' or 'a4').
|
||||
#latex_paper_size = 'letter'
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#latex_font_size = '10pt'
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'Tablib.tex', u'Tablib Documentation',
|
||||
u'Kenneth Reitz', 'manual'),
|
||||
]
|
||||
|
||||
latex_use_modindex = False
|
||||
|
||||
latex_elements = {
|
||||
'fontpkg': r'\usepackage{mathpazo}',
|
||||
'papersize': 'a4paper',
|
||||
'pointsize': '12pt',
|
||||
'preamble': r'\usepackage{krstyle}'
|
||||
}
|
||||
latex_use_parts = True
|
||||
|
||||
latex_additional_files = ['krstyle.sty']
|
||||
|
||||
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#latex_preamble = ''
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'tablib', u'Tablib Documentation',
|
||||
[u'Kenneth Reitz'], 1)
|
||||
]
|
||||
|
||||
sys.path.append(os.path.abspath('_themes'))
|
||||
html_theme_path = ['_themes']
|
||||
html_theme = 'kr'
|
||||
@@ -0,0 +1,246 @@
|
||||
.. _development:
|
||||
|
||||
Development
|
||||
===========
|
||||
|
||||
Tablib is under active development, and contributors are welcome.
|
||||
|
||||
If you have a feature request, suggestion, or bug report, please open a new issue on GitHub_. To submit patches, please send a pull request on GitHub_.
|
||||
|
||||
If you'd like to contribute, there's plenty to do. Here's a short todo list.
|
||||
|
||||
.. include:: ../TODO.rst
|
||||
|
||||
|
||||
.. _GitHub: http://github.com/kennethreitz/tablib/
|
||||
|
||||
|
||||
|
||||
.. _design:
|
||||
|
||||
---------------------
|
||||
Design Considerations
|
||||
---------------------
|
||||
|
||||
Tablib was developed with a few :pep:`20` idioms in mind.
|
||||
|
||||
#. Beautiful is better than ugly.
|
||||
#. Explicit is better than implicit.
|
||||
#. Simple is better than complex.
|
||||
#. Complex is better than complicated.
|
||||
#. Readability counts.
|
||||
|
||||
A few other things to keep in mind:
|
||||
|
||||
#. Keep your code DRY.
|
||||
#. Strive to be as simple (to use) as possible.
|
||||
|
||||
.. _scm:
|
||||
|
||||
--------------
|
||||
Source Control
|
||||
--------------
|
||||
|
||||
|
||||
Tablib source is controlled with Git_, the lean, mean, distributed source control machine.
|
||||
|
||||
The repository is publicly accessable.
|
||||
|
||||
``git clone git://github.com/kennethreitz/tablib.git``
|
||||
|
||||
The project is hosted both on **GitHub** and **git.kennethreitz.com**.
|
||||
|
||||
|
||||
GitHub:
|
||||
http://github.com/kennethreitz/tablib
|
||||
"Mirror":
|
||||
http://git.kennethreitz.com/projects/tablib
|
||||
|
||||
|
||||
Git Branch Structure
|
||||
++++++++++++++++++++
|
||||
|
||||
Feature / Hotfix / Release branches follow a `Successful Git Branching Model`_ . Git-flow_ is a great tool for managing the repository. I highly recommend it.
|
||||
|
||||
``develop``
|
||||
The "next release" branch. Likely unstable.
|
||||
``master``
|
||||
Current production release (|version|) on PyPi.
|
||||
``gh-pages``
|
||||
Current release of http://tablib.org.
|
||||
|
||||
Each release is tagged.
|
||||
|
||||
When submitting patches, please place your feature/change in its own branch prior to opening a pull reqeust on GitHub_.
|
||||
|
||||
|
||||
.. _Git: http://git-scm.org
|
||||
.. _`Successful Git Branching Model`: http://nvie.com/posts/a-successful-git-branching-model/
|
||||
.. _git-flow: http://github.com/nvie/gitflow
|
||||
|
||||
|
||||
.. _newformats:
|
||||
|
||||
------------------
|
||||
Adding New Formats
|
||||
------------------
|
||||
|
||||
Tablib welcomes new format additions! Format suggestions include:
|
||||
|
||||
* Tab Separated Values
|
||||
* MySQL Dump
|
||||
* HTML Table
|
||||
|
||||
|
||||
Coding by Convention
|
||||
++++++++++++++++++++
|
||||
|
||||
Tablib features a micro-framework for adding format support. The easiest way to understand it is to use it. So, let's define our own format, named *xxx*.
|
||||
|
||||
1. Write a new format interface.
|
||||
|
||||
:class:`tablib.core` follows a simple pattern for automatically utilizing your format throughout Tablib. Function names are crucial.
|
||||
|
||||
Example **tablib/formats/_xxx.py**: ::
|
||||
|
||||
title = 'xxx'
|
||||
|
||||
def export_set(dset):
|
||||
....
|
||||
# returns string representation of given dataset
|
||||
|
||||
def export_book(dbook):
|
||||
....
|
||||
# returns string representation of given databook
|
||||
|
||||
def import_set(dset, in_stream):
|
||||
...
|
||||
# populates given Dataset with given datastream
|
||||
|
||||
def import_book(dbook, in_stream):
|
||||
...
|
||||
# returns Databook instance
|
||||
|
||||
def detect(stream):
|
||||
...
|
||||
# returns True if given stream is parsable as xxx
|
||||
|
||||
.. admonition:: Excluding Support
|
||||
|
||||
|
||||
If the format excludes support for an import/export mechanism (*eg.* :class:`csv <tablib.Dataset.csv>` excludes :class:`Databook <tablib.Databook>` support), simply don't define the respective functions. Appropriate errors will be raised.
|
||||
|
||||
2.
|
||||
|
||||
Add your new format module to the :class:`tablib.formats.avalable` tuple.
|
||||
|
||||
3.
|
||||
Add a mock property to the :class:`Dataset <tablib.Dataset>` class with verbose `reStructured Text`_ docstring. This alleviates IDE confusion, and allows for pretty auto-generated Sphinx_ documentation.
|
||||
|
||||
4. Write respective :ref:`tests <testing>`.
|
||||
|
||||
.. _testing:
|
||||
|
||||
--------------
|
||||
Testing Tablib
|
||||
--------------
|
||||
|
||||
Testing is crucial to Tablib's stability. This stable project is used in production by many companies and developers, so it is important to be certain that every version released is fully operational. When developing a new feature for Tablib, be sure to write proper tests for it as well.
|
||||
|
||||
When developing a feature for Tablib, the easiest way to test your changes for potential issues is to simply run the test suite directly. ::
|
||||
|
||||
$ ./test_tablib.py
|
||||
|
||||
|
||||
`Hudson CI`_, amongst other tools, supports Java's xUnit testing report format. Nose_ allows us to generate our own xUnit reports.
|
||||
|
||||
Installing nose is simple. ::
|
||||
|
||||
$ pip install nose
|
||||
|
||||
Once installed, we can generate our xUnit report with a single command. ::
|
||||
|
||||
$ nosetests test_tablib.py --with-xunit
|
||||
|
||||
This will generate a **nosetests.xml** file, which can then be analyzed.
|
||||
|
||||
.. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
|
||||
|
||||
|
||||
|
||||
.. _hudson:
|
||||
|
||||
----------------------
|
||||
Continuous Integration
|
||||
----------------------
|
||||
|
||||
Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Hudson CI`_. If you have access to the main repository and broke the build, you will receive an email accordingly.
|
||||
|
||||
Anyone may view the build status and history at any time.
|
||||
|
||||
http://ci.kennethreitz.com/
|
||||
|
||||
|
||||
If you are trustworthy and plan to contribute to tablib on a regular basis, please contact `Kenneth Reitz`_ to get an account on the Hudson Server.
|
||||
|
||||
|
||||
Additional reports will also be included here in the future, including :pep:`8` checks and stress reports for extremely large datasets.
|
||||
|
||||
.. _`Hudson CI`: http://hudson.dev.java.net
|
||||
.. _`Kenneth Reitz`: http://kennethreitz.com/contact-me/
|
||||
|
||||
|
||||
.. _docs:
|
||||
|
||||
-----------------
|
||||
Building the Docs
|
||||
-----------------
|
||||
|
||||
Documentation is written in the powerful, flexible, and standard Python documentation format, `reStructured Text`_.
|
||||
Documentation builds are powered by the powerful Pocoo project, Sphinx_. The :ref:`API Documentation <api>` is mostly documented inline throughout the module.
|
||||
|
||||
The Docs live in ``tablib/docs``. In order to build them, you will first need to install Sphinx. ::
|
||||
|
||||
$ pip install sphinx
|
||||
|
||||
|
||||
Then, to build an HTML version of the docs, simply run the following from the **docs** directory: ::
|
||||
|
||||
$ make html
|
||||
|
||||
Your ``docs/_build/html`` directory will then contain an HTML representation of the documentation, ready for publication on most web servers.
|
||||
|
||||
You can also generate the documentation in **ebpub**, **latex**, **json**, *&c* similarly.
|
||||
|
||||
.. admonition:: GitHub Pages
|
||||
|
||||
To push the documentation up to `GitHub Pages`_, you will first need to run `sphinx-to-github`_ against your ``docs/_build/html`` directory.
|
||||
|
||||
GitHub Pages are powered by an HTML generation system called Jeckyl_, which is configured to ignore files and folders that begin with "``_``" (*ie.* **_static**).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
and `sphinx-to-github`_. ::
|
||||
|
||||
Installing sphinx-to-github is simple. ::
|
||||
|
||||
$ pip install sphinx-to-github
|
||||
|
||||
Running it against the docs is even simpler. ::
|
||||
|
||||
$ sphinx-to-github _build/html
|
||||
|
||||
Move the resulting files to the **gh-pages** branch of your repository, and push it up to GitHub.
|
||||
|
||||
.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html
|
||||
.. _Sphinx: http://sphinx.pocoo.org
|
||||
.. _`GitHub Pages`: http://pages.github.com
|
||||
.. _Jeckyl: http://github.com/mojombo/jekyll
|
||||
.. _`sphinx-to-github`: http://github.com/michaeljones/sphinx-to-github
|
||||
|
||||
----------
|
||||
|
||||
Make sure to check out the :ref:`API Documentation <api>`.
|
||||
@@ -0,0 +1,64 @@
|
||||
.. Tablib documentation master file, created by
|
||||
sphinx-quickstart on Tue Oct 5 15:25:21 2010.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Tablib: Pythonic Tabular Datasets
|
||||
=================================
|
||||
|
||||
Release |version|.
|
||||
|
||||
.. Contents:
|
||||
..
|
||||
.. .. toctree::
|
||||
.. :maxdepth: 2
|
||||
..
|
||||
|
||||
.. Indices and tables
|
||||
.. ==================
|
||||
..
|
||||
.. * :ref:`genindex`
|
||||
.. * :ref:`modindex`
|
||||
.. * :ref:`search`
|
||||
|
||||
|
||||
Tablib is an :ref:`MIT Licensed <mit>` format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags & filtering, and seamless format import & export.
|
||||
|
||||
I recommend you start with :ref:`Installation <install>`.
|
||||
|
||||
User's Guide
|
||||
------------
|
||||
|
||||
This part of the documentation, which is mostly prose, begins with some background information about Tablib, then focuses on step-by-step instructions for getting the most out of your datasets.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
intro
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
install
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
tutorial
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
development
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
If you are looking for information on a specific function, class or
|
||||
method, this part of the documentation is for you.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api
|
||||
@@ -0,0 +1,78 @@
|
||||
.. _install:
|
||||
Installation
|
||||
============
|
||||
|
||||
This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed. Please read this section carefully, or you may miss out on some nice :ref:`speed enhancements <peed-extentions>`.
|
||||
|
||||
|
||||
.. _installing:
|
||||
|
||||
-----------------
|
||||
Installing Tablib
|
||||
-----------------
|
||||
|
||||
To install Tablib, it only takes one simple command. ::
|
||||
|
||||
$ pip install tablib
|
||||
|
||||
Or, if you must: ::
|
||||
|
||||
$ easy_install tablib
|
||||
|
||||
But, you really shouldn't do that.
|
||||
|
||||
|
||||
-------------------
|
||||
Download the Source
|
||||
-------------------
|
||||
|
||||
You can also install tablib from source. The latest release (|version|) is available from GitHub.
|
||||
|
||||
* tarball_
|
||||
* zipball_
|
||||
|
||||
.. _
|
||||
Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages easily. ::
|
||||
|
||||
$ python setup.py install
|
||||
|
||||
|
||||
To download the full source history from Git, see :ref:`Source Control <scm>`.
|
||||
|
||||
.. _tarball: http://github.com/kennethreitz/tablib/tarball/master
|
||||
.. _zipball: http://github.com/kennethreitz/tablib/zipball/master
|
||||
|
||||
|
||||
.. _speed-extentions:
|
||||
Speed Extentions
|
||||
----------------
|
||||
|
||||
.. versionadded:: 0.8.5
|
||||
|
||||
Tablib is partially dependent on the **pyyaml**, **simplejson**, and **xlwt** modules. To reduce installation issues, fully integrated versions of all required libraries are included in Tablib.
|
||||
|
||||
However, if performance is important to you (and it should be), you can install **pyyaml** with C extentions from PyPi. ::
|
||||
|
||||
$ pip install PyYAML
|
||||
|
||||
If you're using Python 2.5, you should also install the **simplejson** module (pip will do this for you). If you're using Python 2.6+, the built-in **json** module is already optimized and in use. ::
|
||||
|
||||
$ pip install simplejson
|
||||
|
||||
|
||||
|
||||
.. _updates:
|
||||
Staying Updated
|
||||
---------------
|
||||
|
||||
The latest version of Tablib will always be available here:
|
||||
|
||||
* PyPi: http://pypi.python.org/pypi/tablib/
|
||||
* GitHub: http://github.com/kennethreitz/tablib/
|
||||
|
||||
When a new version is available, upgrading is simple. ::
|
||||
|
||||
$ pip install tablib --upgrade
|
||||
|
||||
|
||||
Now, go get a :ref:`Quick Start <quickstart>`.
|
||||
@@ -0,0 +1,84 @@
|
||||
.. _intro:
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
This part of the documentation covers all the interfaces of Tablib.
|
||||
Tablib is a format-agnostic tabular dataset library, written in Python. It allows you to Pythonically import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags / filtering, and seamless format import/export.
|
||||
|
||||
|
||||
Philosphy
|
||||
---------
|
||||
|
||||
Tablib was developed with a few :pep:`20` idioms in mind.
|
||||
|
||||
|
||||
#. Beautiful is better than ugly.
|
||||
#. Explicit is better than implicit.
|
||||
#. Simple is better than complex.
|
||||
#. Complex is better than complicated.
|
||||
#. Readability counts.
|
||||
|
||||
All contributions to Tablib should keep these important rules in mind.
|
||||
|
||||
.. _mit:
|
||||
|
||||
MIT License
|
||||
-----------
|
||||
|
||||
A large number of open source projects you find today are `GPL Licensed`_. While the GPL has its time and place, it should most certainly not be your go-to license for your next open source project.
|
||||
|
||||
A project that is released as GPL cannot be used in any commercial product without the product itself also being offered as open source. The MIT and BSD licenses are great alternatives to the GPL that allow your open-source software to be used in proprietary, closed-source software.
|
||||
|
||||
Tablib is released under terms of `The MIT License`_.
|
||||
|
||||
.. _`GPL Licensed`: http://www.opensource.org/licenses/gpl-license.php
|
||||
.. _`The MIT License`: http://www.opensource.org/licenses/mit-license.php
|
||||
|
||||
|
||||
.. _license:
|
||||
|
||||
Tablib License
|
||||
--------------
|
||||
|
||||
Copyright (c) 2011 Kenneth Reitz.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
|
||||
.. _pythonsupport:
|
||||
|
||||
Pythons Supported
|
||||
-----------------
|
||||
|
||||
At this time, the following Python platforms are officially supported:
|
||||
|
||||
* cPython 2.5
|
||||
* cPython 2.6
|
||||
* cPython 2.7
|
||||
* cPython 3.1
|
||||
* cPython 3.2
|
||||
* PyPy-c 1.4
|
||||
|
||||
Support for other Pythons will be rolled out soon.
|
||||
|
||||
|
||||
|
||||
|
||||
Now, go :ref:`Install Tablib <install>`.
|
||||
@@ -0,0 +1,118 @@
|
||||
\definecolor{TitleColor}{rgb}{0,0,0}
|
||||
\definecolor{InnerLinkColor}{rgb}{0,0,0}
|
||||
|
||||
\renewcommand{\maketitle}{%
|
||||
\begin{titlepage}%
|
||||
\let\footnotesize\small
|
||||
\let\footnoterule\relax
|
||||
\ifsphinxpdfoutput
|
||||
\begingroup
|
||||
% This \def is required to deal with multi-line authors; it
|
||||
% changes \\ to ', ' (comma-space), making it pass muster for
|
||||
% generating document info in the PDF file.
|
||||
\def\\{, }
|
||||
\pdfinfo{
|
||||
/Author (\@author)
|
||||
/Title (\@title)
|
||||
}
|
||||
\endgroup
|
||||
\fi
|
||||
\begin{flushright}%
|
||||
%\sphinxlogo%
|
||||
{\center
|
||||
\vspace*{3cm}
|
||||
\includegraphics{logo.pdf}
|
||||
\vspace{3cm}
|
||||
\par
|
||||
{\rm\Huge \@title \par}%
|
||||
{\em\LARGE \py@release\releaseinfo \par}
|
||||
{\large
|
||||
\@date \par
|
||||
\py@authoraddress \par
|
||||
}}%
|
||||
\end{flushright}%\par
|
||||
\@thanks
|
||||
\end{titlepage}%
|
||||
\cleardoublepage%
|
||||
\setcounter{footnote}{0}%
|
||||
\let\thanks\relax\let\maketitle\relax
|
||||
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
|
||||
}
|
||||
|
||||
\fancypagestyle{normal}{
|
||||
\fancyhf{}
|
||||
\fancyfoot[LE,RO]{{\thepage}}
|
||||
\fancyfoot[LO]{{\nouppercase{\rightmark}}}
|
||||
\fancyfoot[RE]{{\nouppercase{\leftmark}}}
|
||||
\fancyhead[LE,RO]{{ \@title, \py@release}}
|
||||
\renewcommand{\headrulewidth}{0.4pt}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
}
|
||||
|
||||
\fancypagestyle{plain}{
|
||||
\fancyhf{}
|
||||
\fancyfoot[LE,RO]{{\thepage}}
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
}
|
||||
|
||||
\titleformat{\section}{\Large}%
|
||||
{\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
|
||||
\titleformat{\subsection}{\large}%
|
||||
{\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
|
||||
\titleformat{\subsubsection}{}%
|
||||
{\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
|
||||
\titleformat{\paragraph}{\large}%
|
||||
{\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor}
|
||||
|
||||
\ChNameVar{\raggedleft\normalsize}
|
||||
\ChNumVar{\raggedleft \bfseries\Large}
|
||||
\ChTitleVar{\raggedleft \rm\Huge}
|
||||
|
||||
\renewcommand\thepart{\@Roman\c@part}
|
||||
\renewcommand\part{%
|
||||
\pagestyle{empty}
|
||||
\if@noskipsec \leavevmode \fi
|
||||
\cleardoublepage
|
||||
\vspace*{6cm}%
|
||||
\@afterindentfalse
|
||||
\secdef\@part\@spart}
|
||||
|
||||
\def\@part[#1]#2{%
|
||||
\ifnum \c@secnumdepth >\m@ne
|
||||
\refstepcounter{part}%
|
||||
\addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%
|
||||
\else
|
||||
\addcontentsline{toc}{part}{#1}%
|
||||
\fi
|
||||
{\parindent \z@ %\center
|
||||
\interlinepenalty \@M
|
||||
\normalfont
|
||||
\ifnum \c@secnumdepth >\m@ne
|
||||
\rm\Large \partname~\thepart
|
||||
\par\nobreak
|
||||
\fi
|
||||
\MakeUppercase{\rm\Huge #2}%
|
||||
\markboth{}{}\par}%
|
||||
\nobreak
|
||||
\vskip 8ex
|
||||
\@afterheading}
|
||||
\def\@spart#1{%
|
||||
{\parindent \z@ %\center
|
||||
\interlinepenalty \@M
|
||||
\normalfont
|
||||
\huge \bfseries #1\par}%
|
||||
\nobreak
|
||||
\vskip 3ex
|
||||
\@afterheading}
|
||||
|
||||
% use inconsolata font
|
||||
\usepackage{inconsolata}
|
||||
|
||||
% fix single quotes, for inconsolata. (does not work)
|
||||
%%\usepackage{textcomp}
|
||||
%%\begingroup
|
||||
%% \catcode`'=\active
|
||||
%% \g@addto@macro\@noligs{\let'\textsinglequote}
|
||||
%% \endgroup
|
||||
%%\endinput
|
||||
@@ -0,0 +1,353 @@
|
||||
.. _quickstart:
|
||||
|
||||
==========
|
||||
Quickstart
|
||||
==========
|
||||
|
||||
|
||||
.. module:: tablib
|
||||
|
||||
|
||||
Eager to get started? This page gives a good introduction in how to get started with Tablib. This assumes you already have Tablib installed. If you do not, head over to the :ref:`Installation <install>` section.
|
||||
|
||||
First, make sure that:
|
||||
|
||||
* Tablib is :ref:`installed <install>`
|
||||
* Tablib is :ref:`up-to-date <updates>`
|
||||
|
||||
|
||||
Lets gets started with some simple use cases and examples.
|
||||
|
||||
|
||||
|
||||
------------------
|
||||
Creating a Dataset
|
||||
------------------
|
||||
|
||||
|
||||
A :class:`Dataset <tablib.Dataset>` is nothing more than what its name implies—a set of data.
|
||||
|
||||
Creating your own instance of the :class:`tablib.Dataset` object is simple. ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
|
||||
You can now start filling this :class:`Dataset <tablib.Dataset>` object with data.
|
||||
|
||||
.. admonition:: Example Context
|
||||
|
||||
From here on out, if you see ``data``, assume that it's a fresh :class:`Dataset <tablib.Dataset>` object.
|
||||
|
||||
|
||||
|
||||
-----------
|
||||
Adding Rows
|
||||
-----------
|
||||
|
||||
|
||||
Let's say you want to collect a simple list of names. ::
|
||||
|
||||
# collection of names
|
||||
names = ['Kenneth Reitz', 'Bessie Monke']
|
||||
|
||||
for name in names:
|
||||
# split name appropriately
|
||||
fname, lname = name.split()
|
||||
|
||||
# add names to Dataset
|
||||
data.append([fname, lname])
|
||||
|
||||
You can get a nice, Pythonic view of the dataset at any time with :class:`Dataset.dict`.
|
||||
|
||||
>>> data.dict
|
||||
[('Kenneth', 'Reitz'), ('Bessie', 'Monke')]
|
||||
|
||||
|
||||
|
||||
--------------
|
||||
Adding Headers
|
||||
--------------
|
||||
|
||||
|
||||
It's time enhance our :class:`Dataset` by giving our columns some titles. To do so, set :class:`Dataset.headers`. ::
|
||||
|
||||
data.headers = ['First Name', 'Last Name']
|
||||
|
||||
Now our data looks a little different. ::
|
||||
|
||||
>>> data.dict
|
||||
[{'Last Name': 'Reitz', 'First Name': 'Kenneth'}, {'Last Name': 'Monke', 'First Name': 'Bessie'}]
|
||||
|
||||
|
||||
|
||||
|
||||
--------------
|
||||
Adding Columns
|
||||
--------------
|
||||
|
||||
|
||||
Now that we have a basic :class:`Dataset` in place, let's add a column of **ages** to it. ::
|
||||
|
||||
data.append(col=[22, 20], header='Age')
|
||||
|
||||
Let's view the data now. ::
|
||||
|
||||
>>> data.dict
|
||||
[{'Last Name': 'Reitz', 'First Name': 'Kenneth', 'Age': 22}, {'Last Name': 'Monke', 'First Name': 'Bessie', 'Age': 20}]
|
||||
|
||||
It's that easy.
|
||||
|
||||
|
||||
--------------
|
||||
Exporting Data
|
||||
--------------
|
||||
|
||||
Tablib's killer feature is the ability to export your :class:`Dataset` objects into a number of formats.
|
||||
|
||||
**Comma-Separated Values** ::
|
||||
|
||||
>>> data.csv
|
||||
Last Name,First Name,Age
|
||||
Reitz,Kenneth,22
|
||||
Monke,Bessie,20
|
||||
|
||||
**JavaScript Object Notation** ::
|
||||
|
||||
>>> data.json
|
||||
[{"Last Name": "Reitz", "First Name": "Kenneth", "Age": 22}, {"Last Name": "Monke", "First Name": "Bessie", "Age": 20}]
|
||||
|
||||
|
||||
**YAML Ain't Markup Language** ::
|
||||
|
||||
>>> data.yaml
|
||||
- {Age: 22, First Name: Kenneth, Last Name: Reitz}
|
||||
- {Age: 20, First Name: Bessie, Last Name: Monke}
|
||||
|
||||
|
||||
**Microsoft Excel** ::
|
||||
|
||||
>>> data.xls
|
||||
<censored binary data>
|
||||
|
||||
|
||||
------------------------
|
||||
Selecting Rows & Columns
|
||||
------------------------
|
||||
|
||||
|
||||
You can slice and dice your data, just like a standard Python list. ::
|
||||
|
||||
>>> data[0]
|
||||
('Kenneth', 'Reitz', 22)
|
||||
|
||||
|
||||
If we had a set of data consisting of thousands of rows, it could be useful to get a list of values in a column.
|
||||
To do so, we access the :class:`Dataset` as if it were a standard Python dictionary. ::
|
||||
|
||||
>>> data['First Name']
|
||||
['Kenneth', 'Bessie']
|
||||
|
||||
Let's find the average age. ::
|
||||
|
||||
>>> ages = data['Age']
|
||||
>>> float(sum(ages)) / len(ages)
|
||||
21.0
|
||||
|
||||
|
||||
|
||||
-----------------------
|
||||
Removing Rows & Columns
|
||||
-----------------------
|
||||
|
||||
It's easier than you could imagine. ::
|
||||
|
||||
>>> del data['Col Name']
|
||||
|
||||
::
|
||||
|
||||
>>> del data[0:12]
|
||||
|
||||
|
||||
==============
|
||||
Advanced Usage
|
||||
==============
|
||||
|
||||
|
||||
This part of the documentation services to give you an idea that are otherwise hard to extract from the :ref:`API Documentation <api>`
|
||||
|
||||
And now for something completely different.
|
||||
|
||||
|
||||
.. _dyncols:
|
||||
|
||||
---------------
|
||||
Dynamic Columns
|
||||
---------------
|
||||
|
||||
.. versionadded:: 0.8.3
|
||||
|
||||
Thanks to Josh Ourisman, Tablib now supports adding dynamic columns. A dynamic column is a single callable object (*ie.* a function).
|
||||
|
||||
Let's add a dynamic column to our :class:`Dataset` object. In this example, we have a function that generates a random grade for our students. ::
|
||||
|
||||
import random
|
||||
|
||||
def random_grade(row):
|
||||
"""Returns a random integer for entry."""
|
||||
return (random.randint(60,100)/100.0)
|
||||
|
||||
data.append(col=[random_grade], header='Grade')
|
||||
|
||||
Let's have a look at our data. ::
|
||||
|
||||
>>> data.yaml
|
||||
- {Age: 22, First Name: Kenneth, Grade: 0.6, Last Name: Reitz}
|
||||
- {Age: 20, First Name: Bessie, Grade: 0.75, Last Name: Monke}
|
||||
|
||||
|
||||
Let's remove that column. ::
|
||||
|
||||
>>> del data['Grade']
|
||||
|
||||
|
||||
When you add a dynamic column, the first argument that is passed in to the given callable is the current data row. You can use this to perform calculations against your data row.
|
||||
|
||||
For example, we can use the data available in the row to guess the gender of a student. ::
|
||||
|
||||
def guess_gender(row):
|
||||
"""Calculates gender of given student data row."""
|
||||
m_names = ('Kenneth', 'Mike', 'Yuri')
|
||||
f_names = ('Bessie', 'Samantha', 'Heather')
|
||||
|
||||
name = row[0]
|
||||
|
||||
if name in m_names:
|
||||
return 'Male'
|
||||
elif name in f_names:
|
||||
return 'Female'
|
||||
else:
|
||||
return 'Unknown'
|
||||
|
||||
Adding this function to our dataset as a dynamic column would result in: ::
|
||||
|
||||
>>> data.yaml
|
||||
- {Age: 22, First Name: Kenneth, Gender: Male, Last Name: Reitz}
|
||||
- {Age: 20, First Name: Bessie, Gender: Female, Last Name: Monke}
|
||||
|
||||
|
||||
.. _tags:
|
||||
|
||||
----------------------------
|
||||
Filtering Datasets with Tags
|
||||
----------------------------
|
||||
|
||||
.. versionadded:: 0.9.0
|
||||
|
||||
|
||||
When constructing a :class:`Dataset` object, you can add tags to rows by specifying the ``tags`` parameter.
|
||||
This allows you to filter your :class:`Dataset` later. This can be useful so separate rows of data based on
|
||||
arbitrary criteria (*e.g.* origin) that you don't want to include in your :class:`Dataset`.
|
||||
|
||||
Let's tag some students. ::
|
||||
|
||||
students = tablib.Dataset()
|
||||
|
||||
students.headers = ['first', 'last']
|
||||
|
||||
students.append(['Kenneth', 'Reitz'], tags=['male', 'technical'])
|
||||
students.append(['Bessie', 'Monke'], tags=['female', 'creative'])
|
||||
|
||||
Now that we have extra meta-data on our rows, we can use easily filter our :class:`Dataset`. Let's just see Male students. ::
|
||||
|
||||
|
||||
>>> data.filter(['male']).yaml
|
||||
- {first: Kenneth, Last: Reitz}
|
||||
|
||||
It's that simple. The original :class:`Dataset` is untouched.
|
||||
|
||||
|
||||
Excel Workbook With Multiple Sheets
|
||||
------------------------------------
|
||||
|
||||
When dealing with a large number of :class:`Datasets <Dataset>` in spreadsheet format, it's quite common to group multiple spreadsheets into a single Excel file, known as a Workbook. Tablib makes it extremely easy to build workbooks with the handy, :class:`Databook` class.
|
||||
|
||||
|
||||
Let's say we have 3 different :class:`Datasets <Dataset>`. All we have to do is add then to a :class:`Databook` object... ::
|
||||
|
||||
book = tablib.Databook([data1, data2, data3])
|
||||
|
||||
... and export to Excel just like :class:`Datasets <Dataset>`. ::
|
||||
|
||||
with open('students.xls', 'wb') as f:
|
||||
f.write(book.xls)
|
||||
|
||||
The resulting **students.xls** file will contain a separate spreadsheet for each :class:`Dataset` object in the :class:`Databook`.
|
||||
|
||||
.. admonition:: Binary Warning
|
||||
|
||||
Make sure to open the output file in binary mode.
|
||||
|
||||
|
||||
.. _separators:
|
||||
|
||||
----------
|
||||
Separators
|
||||
----------
|
||||
|
||||
.. versionadded:: 0.8.2
|
||||
|
||||
When, it's often useful to create a blank row containing information on the upcoming data. So,
|
||||
|
||||
|
||||
|
||||
::
|
||||
|
||||
daniel_tests = [
|
||||
('11/24/09', 'Math 101 Mid-term Exam', 56.),
|
||||
('05/24/10', 'Math 101 Final Exam', 62.)
|
||||
]
|
||||
|
||||
suzie_tests = [
|
||||
('11/24/09', 'Math 101 Mid-term Exam', 56.),
|
||||
('05/24/10', 'Math 101 Final Exam', 62.)
|
||||
]
|
||||
|
||||
# Create new dataset
|
||||
tests = tablib.Dataset()
|
||||
tests.headers = ['Date', 'Test Name', 'Grade']
|
||||
|
||||
# Daniel's Tests
|
||||
tests.append_separator('Daniel\'s Scores')
|
||||
|
||||
for test_row in daniel_tests:
|
||||
tests.append(test_row)
|
||||
|
||||
# Susie's Tests
|
||||
tests.append_separator('Susie\'s Scores')
|
||||
|
||||
for test_row in suzie_tests:
|
||||
tests.append(test_row)
|
||||
|
||||
# Write spreadsheet to disk
|
||||
with open('grades.xls', 'wb') as f:
|
||||
f.write(tests.xls)
|
||||
|
||||
The resulting **tests.xls** will have the following layout:
|
||||
|
||||
|
||||
Daniel's Scores:
|
||||
* '11/24/09', 'Math 101 Mid-term Exam', 56.
|
||||
* '05/24/10', 'Math 101 Final Exam', 62.
|
||||
|
||||
Suzie's Scores:
|
||||
* '11/24/09', 'Math 101 Mid-term Exam', 56.
|
||||
* '05/24/10', 'Math 101 Final Exam', 62.
|
||||
|
||||
|
||||
|
||||
.. admonition:: Format Support
|
||||
|
||||
At this time, only :class:`Excel <Dataset.xls>` output supports separators.
|
||||
|
||||
----
|
||||
|
||||
Now, go check out the :ref:`API Documentation <api>` or begin :ref:`Tablib Development <development>`.
|
||||
Vendored
-27
@@ -1,27 +0,0 @@
|
||||
from fabric.api import *
|
||||
|
||||
|
||||
def scrub():
|
||||
""" Death to the bytecode! """
|
||||
local("rm -fr dist build")
|
||||
local("find . -name \"*.pyc\" -exec rm '{}' ';'")
|
||||
|
||||
def test():
|
||||
""" Test parsing! """
|
||||
local("rm output/*")
|
||||
local("./strata.py --nsanity_files 'strata/tests/samples/nsanity' -d")
|
||||
|
||||
def build():
|
||||
""" Build application"""
|
||||
pass
|
||||
|
||||
def init():
|
||||
""" Initialize Environment """
|
||||
# TODO: Possibly add Virtual Environment?
|
||||
local("sudo pip install -r REQUIREMENTS")
|
||||
|
||||
if __name__ == '__main__':
|
||||
# TODO: Remove (for testing purposes)
|
||||
# TODO: [Possibly] add doctests
|
||||
test()
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
import os
|
||||
import sys
|
||||
import tablib
|
||||
|
||||
from distutils.core import setup
|
||||
|
||||
@@ -15,22 +15,41 @@ if sys.argv[-1] == "publish":
|
||||
publish()
|
||||
sys.exit()
|
||||
|
||||
setup(name='tablib',
|
||||
version=tablib.__version__,
|
||||
description='Python wrapper for Gist API',
|
||||
long_description=open('README.rst').read() + '\n\n' +
|
||||
open('HISTORY.rst').read(),
|
||||
author='Kenneth Reitz',
|
||||
author_email='me@kennethreitz.com',
|
||||
url='http://github.com/kennethreitz/tabbed',
|
||||
packages=['tablib'],
|
||||
license='MIT',
|
||||
classifiers=(
|
||||
"Development Status :: 4 - Beta",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Programming Language :: Python",
|
||||
"Programming Language :: Python :: 2.5",
|
||||
"Programming Language :: Python :: 2.6",
|
||||
"Programming Language :: Python :: 2.7",
|
||||
)
|
||||
)
|
||||
required = []
|
||||
|
||||
if sys.version_info[:2] < (2,6):
|
||||
required.append('simplejson')
|
||||
|
||||
setup(
|
||||
name='tablib',
|
||||
version='0.9.7',
|
||||
description='Format agnostic tabular data library (XLS, JSON, YAML, CSV)',
|
||||
long_description=open('README.rst').read() + '\n\n' +
|
||||
open('HISTORY.rst').read(),
|
||||
author='Kenneth Reitz',
|
||||
author_email='me@kennethreitz.com',
|
||||
url='http://tablib.org',
|
||||
packages= [
|
||||
'tablib', 'tablib.formats',
|
||||
'tablib.packages',
|
||||
'tablib.packages.xlwt',
|
||||
'tablib.packages.openpyxl',
|
||||
'tablib.packages.yaml',
|
||||
'tablib.packages.unicodecsv'
|
||||
],
|
||||
install_requires=required,
|
||||
license='MIT',
|
||||
classifiers=(
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Intended Audience :: Developers',
|
||||
'Natural Language :: English',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 2.5',
|
||||
'Programming Language :: Python :: 2.6',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3.0',
|
||||
'Programming Language :: Python :: 3.1',
|
||||
'Programming Language :: Python :: 3.2',
|
||||
),
|
||||
)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
"""
|
||||
Tabbed
|
||||
Copyright (c) 2010 Kenneth Reitz. MIT License.
|
||||
"""
|
||||
|
||||
import tablib.cli
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
|
||||
tablib.cli.start()
|
||||
+8
-1
@@ -1 +1,8 @@
|
||||
from core import *
|
||||
""" Tablib.
|
||||
"""
|
||||
|
||||
from tablib.core import (
|
||||
Databook, Dataset, detect, import_set,
|
||||
InvalidDatasetType, InvalidDimensions, UnsupportedFormat
|
||||
)
|
||||
|
||||
|
||||
@@ -1,85 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# encoding: utf-8
|
||||
|
||||
""" Tabbed CLI Inteface Application
|
||||
"""
|
||||
|
||||
import io
|
||||
import sys
|
||||
|
||||
from helpers import *
|
||||
import tablib.core
|
||||
|
||||
from packages import opster
|
||||
|
||||
|
||||
FORMATS = ('json', 'yaml', 'xls', 'csv', 'html')
|
||||
|
||||
opts = []
|
||||
|
||||
opts.append(('v', 'version', False, 'Report tabbed version'))
|
||||
|
||||
for format in FORMATS:
|
||||
opts.append(('', format, False, 'Output to %s' % (format.upper())))
|
||||
|
||||
|
||||
|
||||
@opster.command(options=opts, usage='[FILE] [--FORMAT | FILE]')
|
||||
def start(in_file=None, out_file=None, **opts):
|
||||
"""Covertly convert dataset formats"""
|
||||
|
||||
opts = Object(**opts)
|
||||
|
||||
if opts.version:
|
||||
print('Tabbed, Ver. %s' % tabbed.core.__version__)
|
||||
sys.sys.exit(0)
|
||||
|
||||
stdin = piped()
|
||||
|
||||
if stdin:
|
||||
print stdin
|
||||
|
||||
elif in_file:
|
||||
|
||||
try:
|
||||
in_file = io.open(in_file, 'r')
|
||||
except Exception, e:
|
||||
print(' %s cannot be read.' % in_file)
|
||||
sys.exit(65)
|
||||
|
||||
file_ext = in_file.name.split('.')[-1]
|
||||
|
||||
if file_ext.lower() in FORMATS:
|
||||
setattr(opts, file_ext, True)
|
||||
else:
|
||||
print('Import format not supported.')
|
||||
sys.exit(65)
|
||||
else:
|
||||
print('Please provide input.')
|
||||
sys.exit(65)
|
||||
|
||||
|
||||
|
||||
_formats_sum = sum(opts[f] for f in FORMATS)
|
||||
|
||||
# Multiple output formats given
|
||||
if _formats_sum > 1:
|
||||
print('Please specify a single output format.')
|
||||
sys.exit(64)
|
||||
|
||||
# No output formats given
|
||||
elif _formats_sum < 1:
|
||||
print('Please specify an output format.')
|
||||
sys.exit(64)
|
||||
|
||||
|
||||
# fetch options.formats list
|
||||
# if sum(()) > 1
|
||||
# log only one data format please
|
||||
# if sum of formats == 0, specity format
|
||||
|
||||
# look for filename
|
||||
|
||||
print opts.__dict__
|
||||
print in_file
|
||||
print out_file
|
||||
@@ -0,0 +1,49 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
"""
|
||||
tablib.compat
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Tablib compatiblity module.
|
||||
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
is_py3 = (sys.version_info[0] > 2)
|
||||
|
||||
|
||||
|
||||
try:
|
||||
from collections import OrderedDict
|
||||
except ImportError:
|
||||
from tablib.packages.ordereddict import OrderedDict
|
||||
|
||||
|
||||
if is_py3:
|
||||
from io import BytesIO
|
||||
import tablib.packages.xlwt3 as xlwt
|
||||
from tablib.packages import markup3 as markup
|
||||
from tablib.packages import openpyxl3 as openpyxl
|
||||
|
||||
# py3 mappings
|
||||
ifilter = filter
|
||||
xrange = range
|
||||
unicode = str
|
||||
bytes = bytes
|
||||
basestring = str
|
||||
|
||||
else:
|
||||
from cStringIO import StringIO as BytesIO
|
||||
import tablib.packages.xlwt as xlwt
|
||||
from tablib.packages import markup
|
||||
from itertools import ifilter
|
||||
from tablib.packages import openpyxl
|
||||
|
||||
# py2 mappings
|
||||
xrange = xrange
|
||||
unicode = unicode
|
||||
bytes = str
|
||||
basestring = basestring
|
||||
|
||||
|
||||
+811
-22
@@ -1,38 +1,827 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
tablib.core
|
||||
~~~~~~~~~~~
|
||||
|
||||
# _____ ______ ______ _________
|
||||
# __ /_______ ____ /_ ___ /_ _____ ______ /
|
||||
# _ __/_ __ `/__ __ \__ __ \_ _ \_ __ /
|
||||
# / /_ / /_/ / _ /_/ /_ /_/ // __// /_/ /
|
||||
# \__/ \__,_/ /_.___/ /_.___/ \___/ \__,_/
|
||||
This module implements the central Tablib objects.
|
||||
|
||||
__version__ = '0.0.3'
|
||||
__build__ = '0x000003'
|
||||
:copyright: (c) 2011 by Kenneth Reitz.
|
||||
:license: MIT, see LICENSE for more details.
|
||||
"""
|
||||
|
||||
from copy import copy
|
||||
from operator import itemgetter
|
||||
|
||||
from tablib import formats
|
||||
|
||||
|
||||
from tablib.compat import OrderedDict
|
||||
|
||||
|
||||
__title__ = 'tablib'
|
||||
__version__ = '0.9.7'
|
||||
__build__ = 0x000907
|
||||
__author__ = 'Kenneth Reitz'
|
||||
__license__ = 'MIT'
|
||||
__copyright__ = 'Copyright 2010 Kenneth Reitz'
|
||||
__copyright__ = 'Copyright 2011 Kenneth Reitz'
|
||||
__docformat__ = 'restructuredtext'
|
||||
|
||||
|
||||
def importer():
|
||||
"""docstring for import"""
|
||||
class Row(object):
|
||||
"""Internal Row object. Mainly used for filtering."""
|
||||
|
||||
__slots__ = ['tuple', '_row', 'tags']
|
||||
|
||||
def __init__(self, row=list(), tags=list()):
|
||||
self._row = list(row)
|
||||
self.tags = list(tags)
|
||||
|
||||
def __iter__(self):
|
||||
return (col for col in self._row)
|
||||
|
||||
def __len__(self):
|
||||
return len(self._row)
|
||||
|
||||
def __repr__(self):
|
||||
return repr(self._row)
|
||||
|
||||
def __getslice__(self, i, j):
|
||||
return self._row[i,j]
|
||||
|
||||
def __getitem__(self, i):
|
||||
return self._row[i]
|
||||
|
||||
def __setitem__(self, i, value):
|
||||
self._row[i] = value
|
||||
|
||||
def __delitem__(self, i):
|
||||
del self._row[i]
|
||||
|
||||
def __getstate__(self):
|
||||
return {slot: [getattr(self, slot) for slot in self.__slots__]}
|
||||
|
||||
def __setstate__(self, state):
|
||||
for (k, v) in list(state.items()): setattr(self, k, v)
|
||||
|
||||
def append(self, value):
|
||||
self._row.append(value)
|
||||
|
||||
def insert(self, index, value):
|
||||
self._row.insert(index, value)
|
||||
|
||||
def __contains__(self, item):
|
||||
return (item in self._row)
|
||||
|
||||
@property
|
||||
def tuple(self):
|
||||
'''Tuple representation of :class:`Row`.'''
|
||||
return tuple(self._row)
|
||||
|
||||
@property
|
||||
def list(self):
|
||||
'''List representation of :class:`Row`.'''
|
||||
return list(self._row)
|
||||
|
||||
def has_tag(self, tag):
|
||||
"""Returns true if current row contains tag."""
|
||||
|
||||
if tag == None:
|
||||
return False
|
||||
elif isinstance(tag, str):
|
||||
return (tag in self.tags)
|
||||
else:
|
||||
return bool(len(set(tag) & set(self.tags)))
|
||||
|
||||
|
||||
|
||||
class Data(object):
|
||||
"""test"""
|
||||
def __init__(self):
|
||||
pass
|
||||
self.headers = None
|
||||
|
||||
class Dataset(object):
|
||||
"""The :class:`Dataset` object is the heart of Tablib. It provides all core
|
||||
functionality.
|
||||
|
||||
Usually you create a :class:`Dataset` instance in your main module, and append
|
||||
rows and columns as you collect data. ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.headers = ('name', 'age')
|
||||
|
||||
for (name, age) in some_collector():
|
||||
data.append((name, age))
|
||||
|
||||
You can also set rows and headers upon instantiation. This is useful if dealing
|
||||
with dozens or hundres of :class:`Dataset` objects. ::
|
||||
|
||||
headers = ('first_name', 'last_name')
|
||||
data = [('John', 'Adams'), ('George', 'Washington')]
|
||||
|
||||
data = tablib.Dataset(*data, headers=headers)
|
||||
|
||||
|
||||
|
||||
:param \*args: (optional) list of rows to populate Dataset
|
||||
:param headers: (optional) list strings for Dataset header row
|
||||
|
||||
def add_row(self, index=None):
|
||||
pass
|
||||
|
||||
def del_row(self):
|
||||
pass
|
||||
.. admonition:: Format Attributes Definition
|
||||
|
||||
def save(self):
|
||||
pass
|
||||
If you look at the code, the various output/import formats are not
|
||||
defined within the :class:`Dataset` object. To add support for a new format, see
|
||||
:ref:`Adding New Formats <newformats>`.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
self._data = list(Row(arg) for arg in args)
|
||||
self.__headers = None
|
||||
|
||||
# ('title', index) tuples
|
||||
self._separators = []
|
||||
|
||||
# (column, callback) tuples
|
||||
self._formatters = []
|
||||
|
||||
try:
|
||||
self.headers = kwargs['headers']
|
||||
except KeyError:
|
||||
self.headers = None
|
||||
|
||||
try:
|
||||
self.title = kwargs['title']
|
||||
except KeyError:
|
||||
self.title = None
|
||||
|
||||
self._register_formats()
|
||||
|
||||
|
||||
def __len__(self):
|
||||
return self.height
|
||||
|
||||
|
||||
def __getitem__(self, key):
|
||||
if isinstance(key, str):
|
||||
if key in self.headers:
|
||||
pos = self.headers.index(key) # get 'key' index from each data
|
||||
return [row[pos] for row in self._data]
|
||||
else:
|
||||
raise KeyError
|
||||
else:
|
||||
_results = self._data[key]
|
||||
if isinstance(_results, Row):
|
||||
return _results.tuple
|
||||
else:
|
||||
return [result.tuple for result in _results]
|
||||
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
self._validate(value)
|
||||
self._data[key] = Row(value)
|
||||
|
||||
|
||||
def __delitem__(self, key):
|
||||
if isinstance(key, str):
|
||||
|
||||
if key in self.headers:
|
||||
|
||||
pos = self.headers.index(key)
|
||||
del self.headers[pos]
|
||||
|
||||
for i, row in enumerate(self._data):
|
||||
|
||||
del row[pos]
|
||||
self._data[i] = row
|
||||
else:
|
||||
raise KeyError
|
||||
else:
|
||||
del self._data[key]
|
||||
|
||||
|
||||
def __repr__(self):
|
||||
try:
|
||||
return '<%s dataset>' % (self.title.lower())
|
||||
except AttributeError:
|
||||
return '<dataset object>'
|
||||
|
||||
|
||||
@classmethod
|
||||
def _register_formats(cls):
|
||||
"""Adds format properties."""
|
||||
for fmt in formats.available:
|
||||
try:
|
||||
try:
|
||||
setattr(cls, fmt.title, property(fmt.export_set, fmt.import_set))
|
||||
except AttributeError:
|
||||
setattr(cls, fmt.title, property(fmt.export_set))
|
||||
|
||||
except AttributeError:
|
||||
pass
|
||||
|
||||
|
||||
def _validate(self, row=None, col=None, safety=False):
|
||||
"""Assures size of every row in dataset is of proper proportions."""
|
||||
if row:
|
||||
is_valid = (len(row) == self.width) if self.width else True
|
||||
elif col:
|
||||
if len(col) < 1:
|
||||
is_valid = True
|
||||
else:
|
||||
is_valid = (len(col) == self.height) if self.height else True
|
||||
else:
|
||||
is_valid = all((len(x) == self.width for x in self._data))
|
||||
|
||||
if is_valid:
|
||||
return True
|
||||
else:
|
||||
if not safety:
|
||||
raise InvalidDimensions
|
||||
return False
|
||||
|
||||
|
||||
def _package(self, dicts=True):
|
||||
"""Packages Dataset into lists of dictionaries for transmission."""
|
||||
|
||||
_data = list(self._data)
|
||||
|
||||
# Execute formatters
|
||||
if self._formatters:
|
||||
for row_i, row in enumerate(_data):
|
||||
for col, callback in self._formatters:
|
||||
try:
|
||||
if col is None:
|
||||
for j, c in enumerate(row):
|
||||
_data[row_i][j] = callback(c)
|
||||
else:
|
||||
_data[row_i][col] = callback(row[col])
|
||||
except IndexError:
|
||||
raise InvalidDatasetIndex
|
||||
|
||||
|
||||
if self.headers:
|
||||
if dicts:
|
||||
data = [OrderedDict(list(zip(self.headers, data_row))) for data_row in _data]
|
||||
else:
|
||||
data = [list(self.headers)] + list(_data)
|
||||
else:
|
||||
data = [list(row) for row in _data]
|
||||
|
||||
return data
|
||||
|
||||
|
||||
def _clean_col(self, col):
|
||||
"""Prepares the given column for insert/append."""
|
||||
|
||||
col = list(col)
|
||||
|
||||
if self.headers:
|
||||
header = [col.pop(0)]
|
||||
else:
|
||||
header = []
|
||||
|
||||
if len(col) == 1 and hasattr(col[0], '__call__'):
|
||||
|
||||
col = list(map(col[0], self._data))
|
||||
col = tuple(header + col)
|
||||
|
||||
return col
|
||||
|
||||
|
||||
@property
|
||||
def height(self):
|
||||
"""The number of rows currently in the :class:`Dataset`.
|
||||
Cannot be directly modified.
|
||||
"""
|
||||
return len(self._data)
|
||||
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""The number of columns currently in the :class:`Dataset`.
|
||||
Cannot be directly modified.
|
||||
"""
|
||||
|
||||
try:
|
||||
return len(self._data[0])
|
||||
except IndexError:
|
||||
try:
|
||||
return len(self.headers)
|
||||
except TypeError:
|
||||
return 0
|
||||
|
||||
|
||||
def _get_headers(self):
|
||||
"""An *optional* list of strings to be used for header rows and attribute names.
|
||||
|
||||
This must be set manually. The given list length must equal :class:`Dataset.width`.
|
||||
|
||||
"""
|
||||
return self.__headers
|
||||
|
||||
|
||||
def _set_headers(self, collection):
|
||||
"""Validating headers setter."""
|
||||
self._validate(collection)
|
||||
if collection:
|
||||
try:
|
||||
self.__headers = list(collection)
|
||||
except TypeError:
|
||||
raise TypeError
|
||||
else:
|
||||
self.__headers = None
|
||||
|
||||
headers = property(_get_headers, _set_headers)
|
||||
|
||||
def _get_dict(self):
|
||||
"""A native Python representation of the :class:`Dataset` object. If headers have
|
||||
been set, a list of Python dictionaries will be returned. If no headers have been set,
|
||||
a list of tuples (rows) will be returned instead.
|
||||
|
||||
A dataset object can also be imported by setting the `Dataset.dict` attribute: ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.json = '[{"last_name": "Adams","age": 90,"first_name": "John"}]'
|
||||
|
||||
"""
|
||||
return self._package()
|
||||
|
||||
|
||||
def _set_dict(self, pickle):
|
||||
"""A native Python representation of the Dataset object. If headers have been
|
||||
set, a list of Python dictionaries will be returned. If no headers have been
|
||||
set, a list of tuples (rows) will be returned instead.
|
||||
|
||||
A dataset object can also be imported by setting the :class:`Dataset.dict` attribute. ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.dict = [{'age': 90, 'first_name': 'Kenneth', 'last_name': 'Reitz'}]
|
||||
|
||||
"""
|
||||
|
||||
if not len(pickle):
|
||||
return
|
||||
|
||||
# if list of rows
|
||||
if isinstance(pickle[0], list):
|
||||
self.wipe()
|
||||
for row in pickle:
|
||||
self.append(Row(row))
|
||||
|
||||
# if list of objects
|
||||
elif isinstance(pickle[0], dict):
|
||||
self.wipe()
|
||||
self.headers = list(pickle[0].keys())
|
||||
for row in pickle:
|
||||
self.append(Row(list(row.values())))
|
||||
else:
|
||||
raise UnsupportedFormat
|
||||
|
||||
dict = property(_get_dict, _set_dict)
|
||||
|
||||
|
||||
@property
|
||||
def xls():
|
||||
"""An Excel Spreadsheet representation of the :class:`Dataset` object, with :ref:`separators`. Cannot be set.
|
||||
|
||||
.. admonition:: Binary Warning
|
||||
|
||||
:class:`Dataset.xls` contains binary data, so make sure to write in binary mode::
|
||||
|
||||
with open('output.xls', 'wb') as f:
|
||||
f.write(data.xls)'
|
||||
"""
|
||||
pass
|
||||
|
||||
@property
|
||||
def xlsx():
|
||||
"""An Excel Spreadsheet representation of the :class:`Dataset` object, with :ref:`separators`. Cannot be set.
|
||||
|
||||
.. admonition:: Binary Warning
|
||||
|
||||
:class:`Dataset.xlsx` contains binary data, so make sure to write in binary mode::
|
||||
|
||||
with open('output.xlsx', 'wb') as f:
|
||||
f.write(data.xlsx)'
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
@property
|
||||
def csv():
|
||||
"""A CSV representation of the :class:`Dataset` object. The top row will contain
|
||||
headers, if they have been set. Otherwise, the top row will contain
|
||||
the first row of the dataset.
|
||||
|
||||
A dataset object can also be imported by setting the :class:`Dataset.csv` attribute. ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.csv = 'age, first_name, last_name\\n90, John, Adams'
|
||||
|
||||
Import assumes (for now) that headers exist.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
@property
|
||||
def tsv():
|
||||
"""A TSV representation of the :class:`Dataset` object. The top row will contain
|
||||
headers, if they have been set. Otherwise, the top row will contain
|
||||
the first row of the dataset.
|
||||
|
||||
A dataset object can also be imported by setting the :class:`Dataset.tsv` attribute. ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.tsv = 'age\tfirst_name\tlast_name\\n90\tJohn\tAdams'
|
||||
|
||||
Import assumes (for now) that headers exist.
|
||||
"""
|
||||
|
||||
@property
|
||||
def yaml():
|
||||
"""A YAML representation of the :class:`Dataset` object. If headers have been
|
||||
set, a YAML list of objects will be returned. If no headers have
|
||||
been set, a YAML list of lists (rows) will be returned instead.
|
||||
|
||||
A dataset object can also be imported by setting the :class:`Dataset.json` attribute: ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.yaml = '- {age: 90, first_name: John, last_name: Adams}'
|
||||
|
||||
Import assumes (for now) that headers exist.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
@property
|
||||
def json():
|
||||
"""A JSON representation of the :class:`Dataset` object. If headers have been
|
||||
set, a JSON list of objects will be returned. If no headers have
|
||||
been set, a JSON list of lists (rows) will be returned instead.
|
||||
|
||||
A dataset object can also be imported by setting the :class:`Dataset.json` attribute: ::
|
||||
|
||||
data = tablib.Dataset()
|
||||
data.json = '[{age: 90, first_name: "John", liast_name: "Adams"}]'
|
||||
|
||||
Import assumes (for now) that headers exist.
|
||||
"""
|
||||
|
||||
@property
|
||||
def html():
|
||||
"""A HTML table representation of the :class:`Dataset` object. If
|
||||
headers have been set, they will be used as table headers.
|
||||
|
||||
..notice:: This method can be used for export only.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
def append(self, row=None, col=None, header=None, tags=list()):
|
||||
"""Adds a row or column to the :class:`Dataset`.
|
||||
Usage is :class:`Dataset.insert` for documentation.
|
||||
"""
|
||||
|
||||
if row is not None:
|
||||
self.insert(self.height, row=row, tags=tags)
|
||||
elif col is not None:
|
||||
self.insert(self.width, col=col, header=header)
|
||||
|
||||
|
||||
def insert_separator(self, index, text='-'):
|
||||
"""Adds a separator to :class:`Dataset` at given index."""
|
||||
|
||||
sep = (index, text)
|
||||
self._separators.append(sep)
|
||||
|
||||
|
||||
def append_separator(self, text='-'):
|
||||
"""Adds a :ref:`separator <separators>` to the :class:`Dataset`."""
|
||||
|
||||
# change offsets if headers are or aren't defined
|
||||
if not self.headers:
|
||||
index = self.height if self.height else 0
|
||||
else:
|
||||
index = (self.height + 1) if self.height else 1
|
||||
|
||||
self.insert_separator(index, text)
|
||||
|
||||
|
||||
def add_formatter(self, col, handler):
|
||||
"""Adds a :ref:`formatter` to the :class:`Dataset`.
|
||||
|
||||
.. versionadded:: 0.9.5
|
||||
:param col: column to. Accepts index int or header str.
|
||||
:param handler: reference to callback function to execute
|
||||
against each cell value.
|
||||
"""
|
||||
|
||||
if isinstance(col, str):
|
||||
if col in self.headers:
|
||||
col = self.headers.index(col) # get 'key' index from each data
|
||||
else:
|
||||
raise KeyError
|
||||
|
||||
if not col > self.width:
|
||||
self._formatters.append((col, handler))
|
||||
else:
|
||||
raise InvalidDatasetIndex
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def insert(self, index, row=None, col=None, header=None, tags=list()):
|
||||
"""Inserts a row or column to the :class:`Dataset` at the given index.
|
||||
|
||||
Rows and columns inserted must be the correct size (height or width).
|
||||
|
||||
The default behaviour is to insert the given row to the :class:`Dataset`
|
||||
object at the given index. If the ``col`` parameter is given, however,
|
||||
a new column will be insert to the :class:`Dataset` object instead.
|
||||
|
||||
You can also insert a column of a single callable object, which will
|
||||
add a new column with the return values of the callable each as an
|
||||
item in the column. ::
|
||||
|
||||
data.append(col=random.randint)
|
||||
|
||||
See :ref:`dyncols` for an in-depth example.
|
||||
|
||||
.. versionchanged:: 0.9.0
|
||||
If inserting a column, and :class:`Dataset.headers` is set, the
|
||||
header attribute must be set, and will be considered the header for
|
||||
that row.
|
||||
|
||||
.. versionadded:: 0.9.0
|
||||
If inserting a row, you can add :ref:`tags <tags>` to the row you are inserting.
|
||||
This gives you the ability to :class:`filter <Dataset.filter>` your
|
||||
:class:`Dataset` later.
|
||||
|
||||
"""
|
||||
if row:
|
||||
self._validate(row)
|
||||
self._data.insert(index, Row(row, tags=tags))
|
||||
elif col:
|
||||
col = list(col)
|
||||
|
||||
# Callable Columns...
|
||||
if len(col) == 1 and hasattr(col[0], '__call__'):
|
||||
col = list(map(col[0], self._data))
|
||||
|
||||
col = self._clean_col(col)
|
||||
self._validate(col=col)
|
||||
|
||||
if self.headers:
|
||||
# pop the first item off, add to headers
|
||||
if not header:
|
||||
raise HeadersNeeded()
|
||||
self.headers.insert(index, header)
|
||||
|
||||
if self.height and self.width:
|
||||
|
||||
for i, row in enumerate(self._data):
|
||||
|
||||
row.insert(index, col[i])
|
||||
self._data[i] = row
|
||||
else:
|
||||
self._data = [Row([row]) for row in col]
|
||||
|
||||
|
||||
def filter(self, tag):
|
||||
"""Returns a new instance of the :class:`Dataset`, excluding any rows
|
||||
that do not contain the given :ref:`tags <tags>`.
|
||||
"""
|
||||
_dset = copy(self)
|
||||
_dset._data = [row for row in _dset._data if row.has_tag(tag)]
|
||||
|
||||
return _dset
|
||||
|
||||
|
||||
def sort(self, col, reverse=False):
|
||||
"""Sort a :class:`Dataset` by a specific column, given string (for
|
||||
header) or integer (for column index). The order can be reversed by
|
||||
setting ``reverse`` to ``True``.
|
||||
Returns a new :class:`Dataset` instance where columns have been
|
||||
sorted."""
|
||||
|
||||
if isinstance(col, str):
|
||||
|
||||
if not self.headers:
|
||||
raise HeadersNeeded
|
||||
|
||||
_sorted = sorted(self.dict, key=itemgetter(col), reverse=reverse)
|
||||
_dset = Dataset(headers=self.headers)
|
||||
|
||||
for item in _sorted:
|
||||
row = [item[key] for key in self.headers]
|
||||
_dset.append(row=row)
|
||||
|
||||
else:
|
||||
if self.headers:
|
||||
col = self.headers[col]
|
||||
|
||||
_sorted = sorted(self.dict, key=itemgetter(col), reverse=reverse)
|
||||
_dset = Dataset(headers=self.headers)
|
||||
|
||||
for item in _sorted:
|
||||
if self.headers:
|
||||
row = [item[key] for key in self.headers]
|
||||
else:
|
||||
row = item
|
||||
_dset.append(row=row)
|
||||
|
||||
|
||||
return _dset
|
||||
|
||||
|
||||
def transpose(self):
|
||||
"""Transpose a :class:`Dataset`, turning rows into columns and vice
|
||||
versa, returning a new ``Dataset`` instance. The first row of the
|
||||
original instance becomes the new header row."""
|
||||
|
||||
# Don't transpose if there is no data
|
||||
if not self:
|
||||
return
|
||||
|
||||
_dset = Dataset()
|
||||
# The first element of the headers stays in the headers,
|
||||
# it is our "hinge" on which we rotate the data
|
||||
new_headers = [self.headers[0]] + self[self.headers[0]]
|
||||
|
||||
_dset.headers = new_headers
|
||||
for column in self.headers:
|
||||
|
||||
if column == self.headers[0]:
|
||||
# It's in the headers, so skip it
|
||||
continue
|
||||
|
||||
# Adding the column name as now they're a regular column
|
||||
row_data = [column] + self[column]
|
||||
row_data = Row(row_data)
|
||||
_dset.append(row=row_data)
|
||||
|
||||
return _dset
|
||||
|
||||
|
||||
def stack_rows(self, other):
|
||||
"""Stack two :class:`Dataset` instances together by
|
||||
joining at the row level, and return new combined
|
||||
``Dataset`` instance."""
|
||||
|
||||
if not isinstance(other, Dataset):
|
||||
return
|
||||
|
||||
if self.width != other.width:
|
||||
raise InvalidDimensions
|
||||
|
||||
# Copy the source data
|
||||
_dset = copy(self)
|
||||
|
||||
rows_to_stack = [row for row in _dset._data]
|
||||
other_rows = [row for row in other._data]
|
||||
|
||||
rows_to_stack.extend(other_rows)
|
||||
_dset._data = rows_to_stack
|
||||
|
||||
return _dset
|
||||
|
||||
|
||||
def stack_columns(self, other):
|
||||
"""Stack two :class:`Dataset` instances together by
|
||||
joining at the column level, and return a new
|
||||
combined ``Dataset`` instance. If either ``Dataset``
|
||||
has headers set, than the other must as well."""
|
||||
|
||||
if not isinstance(other, Dataset):
|
||||
return
|
||||
|
||||
if self.headers or other.headers:
|
||||
if not self.headers or not other.headers:
|
||||
raise HeadersNeeded
|
||||
|
||||
if self.height != other.height:
|
||||
raise InvalidDimensions
|
||||
|
||||
try:
|
||||
new_headers = self.headers + other.headers
|
||||
except TypeError:
|
||||
new_headers = None
|
||||
|
||||
_dset = Dataset()
|
||||
|
||||
for column in self.headers:
|
||||
_dset.append(col=self[column])
|
||||
|
||||
for column in other.headers:
|
||||
_dset.append(col=other[column])
|
||||
|
||||
_dset.headers = new_headers
|
||||
|
||||
return _dset
|
||||
|
||||
|
||||
def wipe(self):
|
||||
"""Removes all content and headers from the :class:`Dataset` object."""
|
||||
self._data = list()
|
||||
self.__headers = None
|
||||
|
||||
|
||||
|
||||
class Databook(object):
|
||||
"""A book of :class:`Dataset` objects.
|
||||
"""
|
||||
|
||||
def __init__(self, sets=None):
|
||||
|
||||
if sets is None:
|
||||
self._datasets = list()
|
||||
else:
|
||||
self._datasets = sets
|
||||
|
||||
self._register_formats()
|
||||
|
||||
def __repr__(self):
|
||||
try:
|
||||
return '<%s databook>' % (self.title.lower())
|
||||
except AttributeError:
|
||||
return '<databook object>'
|
||||
|
||||
|
||||
def wipe(self):
|
||||
"""Removes all :class:`Dataset` objects from the :class:`Databook`."""
|
||||
self._datasets = []
|
||||
|
||||
|
||||
@classmethod
|
||||
def _register_formats(cls):
|
||||
"""Adds format properties."""
|
||||
for fmt in formats.available:
|
||||
try:
|
||||
try:
|
||||
setattr(cls, fmt.title, property(fmt.export_book, fmt.import_book))
|
||||
except AttributeError:
|
||||
setattr(cls, fmt.title, property(fmt.export_book))
|
||||
|
||||
except AttributeError:
|
||||
pass
|
||||
|
||||
|
||||
def add_sheet(self, dataset):
|
||||
"""Adds given :class:`Dataset` to the :class:`Databook`."""
|
||||
if type(dataset) is Dataset:
|
||||
self._datasets.append(dataset)
|
||||
else:
|
||||
raise InvalidDatasetType
|
||||
|
||||
|
||||
def _package(self):
|
||||
"""Packages :class:`Databook` for delivery."""
|
||||
collector = []
|
||||
for dset in self._datasets:
|
||||
collector.append(OrderedDict(
|
||||
title = dset.title,
|
||||
data = dset.dict
|
||||
))
|
||||
return collector
|
||||
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""The number of the :class:`Dataset` objects within :class:`Databook`."""
|
||||
return len(self._datasets)
|
||||
|
||||
|
||||
def detect(stream):
|
||||
"""Return (format, stream) of given stream."""
|
||||
for fmt in formats.available:
|
||||
try:
|
||||
if fmt.detect(stream):
|
||||
return (fmt, stream)
|
||||
except AttributeError:
|
||||
pass
|
||||
return (None, stream)
|
||||
|
||||
|
||||
def import_set(stream):
|
||||
"""Return dataset of given stream."""
|
||||
(format, stream) = detect(stream)
|
||||
|
||||
try:
|
||||
data = Dataset()
|
||||
format.import_set(data, stream)
|
||||
return data
|
||||
|
||||
except AttributeError:
|
||||
return None
|
||||
|
||||
|
||||
class InvalidDatasetType(Exception):
|
||||
"Only Datasets can be added to a DataBook"
|
||||
|
||||
|
||||
class InvalidDimensions(Exception):
|
||||
"Invalid size"
|
||||
|
||||
class InvalidDatasetIndex(Exception):
|
||||
"Outside of Dataset size"
|
||||
|
||||
class HeadersNeeded(Exception):
|
||||
"Header parameter must be given when appending a column in this Dataset."
|
||||
|
||||
class UnsupportedFormat(NotImplementedError):
|
||||
"Format is not supported"
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - formats
|
||||
"""
|
||||
|
||||
from . import _csv as csv
|
||||
from . import _json as json
|
||||
from . import _xls as xls
|
||||
from . import _yaml as yaml
|
||||
from . import _tsv as tsv
|
||||
from . import _html as html
|
||||
from . import _xlsx as xlsx
|
||||
|
||||
available = (json, xls, yaml, csv, tsv, html, xlsx)
|
||||
@@ -0,0 +1,70 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - CSV Support.
|
||||
"""
|
||||
|
||||
import sys
|
||||
if sys.version_info[0] > 2:
|
||||
is_py3 = True
|
||||
|
||||
from io import StringIO
|
||||
import csv
|
||||
else:
|
||||
is_py3 = False
|
||||
from cStringIO import StringIO
|
||||
import tablib.packages.unicodecsv as csv
|
||||
|
||||
|
||||
|
||||
import os
|
||||
|
||||
import tablib
|
||||
|
||||
|
||||
title = 'csv'
|
||||
extentions = ('csv',)
|
||||
|
||||
|
||||
DEFAULT_ENCODING = 'utf-8'
|
||||
|
||||
|
||||
|
||||
def export_set(dataset):
|
||||
"""Returns CSV representation of Dataset."""
|
||||
stream = StringIO()
|
||||
|
||||
if is_py3:
|
||||
_csv = csv.writer(stream)
|
||||
else:
|
||||
_csv = csv.writer(stream, encoding=DEFAULT_ENCODING)
|
||||
|
||||
for row in dataset._package(dicts=False):
|
||||
_csv.writerow(row)
|
||||
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def import_set(dset, in_stream, headers=True):
|
||||
"""Returns dataset from CSV stream."""
|
||||
|
||||
dset.wipe()
|
||||
|
||||
if is_py3:
|
||||
rows = csv.reader(in_stream.splitlines())
|
||||
else:
|
||||
rows = csv.reader(in_stream.splitlines(), encoding=DEFAULT_ENCODING)
|
||||
for i, row in enumerate(rows):
|
||||
|
||||
if (i == 0) and (headers):
|
||||
dset.headers = row
|
||||
else:
|
||||
dset.append(row)
|
||||
|
||||
|
||||
def detect(stream):
|
||||
"""Returns True if given stream is valid CSV."""
|
||||
try:
|
||||
rows = dialect = csv.Sniffer().sniff(stream)
|
||||
return True
|
||||
except csv.Error:
|
||||
return False
|
||||
@@ -0,0 +1,60 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - HTML export support.
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
|
||||
if sys.version_info[0] > 2:
|
||||
from io import StringIO
|
||||
from tablib.packages import markup3 as markup
|
||||
else:
|
||||
from cStringIO import StringIO
|
||||
from tablib.packages import markup
|
||||
|
||||
import tablib
|
||||
|
||||
BOOK_ENDINGS = 'h3'
|
||||
|
||||
title = 'html'
|
||||
extentions = ('html', )
|
||||
|
||||
|
||||
def export_set(dataset):
|
||||
"""HTML representation of a Dataset."""
|
||||
|
||||
stream = StringIO()
|
||||
|
||||
page = markup.page()
|
||||
page.table.open()
|
||||
|
||||
if dataset.headers is not None:
|
||||
page.thead.open()
|
||||
headers = markup.oneliner.th(dataset.headers)
|
||||
page.tr(headers)
|
||||
page.thead.close()
|
||||
|
||||
for row in dataset:
|
||||
html_row = markup.oneliner.td(row)
|
||||
page.tr(html_row)
|
||||
|
||||
page.table.close()
|
||||
|
||||
stream.writelines(str(page))
|
||||
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def export_book(databook):
|
||||
"""HTML representation of a Databook."""
|
||||
|
||||
stream = StringIO()
|
||||
|
||||
for i, dset in enumerate(databook._datasets):
|
||||
title = (dset.title if dset.title else 'Set %s' % (i))
|
||||
stream.write('<%s>%s</%s>\n' % (BOOK_ENDINGS, title, BOOK_ENDINGS))
|
||||
stream.write(dset.html)
|
||||
stream.write('\n')
|
||||
|
||||
return stream.getvalue()
|
||||
@@ -0,0 +1,54 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - JSON Support
|
||||
"""
|
||||
|
||||
import tablib
|
||||
|
||||
import sys
|
||||
if sys.version_info[:2] > (2, 5):
|
||||
from tablib.packages import anyjson
|
||||
else:
|
||||
from tablib.packages import anyjson25 as anyjson
|
||||
|
||||
|
||||
|
||||
title = 'json'
|
||||
extentions = ('json', 'jsn')
|
||||
|
||||
|
||||
def export_set(dataset):
|
||||
"""Returns JSON representation of Dataset."""
|
||||
return anyjson.serialize(dataset.dict)
|
||||
|
||||
|
||||
def export_book(databook):
|
||||
"""Returns JSON representation of Databook."""
|
||||
return anyjson.serialize(databook._package())
|
||||
|
||||
|
||||
def import_set(dset, in_stream):
|
||||
"""Returns dataset from JSON stream."""
|
||||
|
||||
dset.wipe()
|
||||
dset.dict = anyjson.deserialize(in_stream)
|
||||
|
||||
|
||||
def import_book(dbook, in_stream):
|
||||
"""Returns databook from JSON stream."""
|
||||
|
||||
dbook.wipe()
|
||||
for sheet in anyjson.deserialize(in_stream):
|
||||
data = tablib.Dataset()
|
||||
data.title = sheet['title']
|
||||
data.dict = sheet['data']
|
||||
dbook.add_sheet(data)
|
||||
|
||||
|
||||
def detect(stream):
|
||||
"""Returns True if given stream is valid JSON."""
|
||||
try:
|
||||
anyjson.deserialize(stream)
|
||||
return True
|
||||
except ValueError:
|
||||
return False
|
||||
@@ -0,0 +1,56 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - TSV (Tab Separated Values) Support.
|
||||
"""
|
||||
|
||||
import sys
|
||||
if sys.version_info[0] > 2:
|
||||
from io import StringIO
|
||||
else:
|
||||
from cStringIO import StringIO
|
||||
|
||||
import csv
|
||||
import os
|
||||
|
||||
import tablib
|
||||
|
||||
|
||||
title = 'tsv'
|
||||
extentions = ('tsv',)
|
||||
|
||||
|
||||
|
||||
def export_set(dataset):
|
||||
"""Returns a TSV representation of Dataset."""
|
||||
stream = StringIO()
|
||||
_tsv = csv.writer(stream, delimiter='\t')
|
||||
|
||||
for row in dataset._package(dicts=False):
|
||||
_tsv.writerow(row)
|
||||
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def import_set(dset, in_stream, headers=True):
|
||||
"""Returns dataset from TSV stream."""
|
||||
dset.wipe()
|
||||
|
||||
rows = csv.reader(in_stream.split('\r\n'), delimiter='\t')
|
||||
for i, row in enumerate(rows):
|
||||
# Skip empty rows
|
||||
if not row:
|
||||
continue
|
||||
|
||||
if (i == 0) and (headers):
|
||||
dset.headers = row
|
||||
else:
|
||||
dset.append(row)
|
||||
|
||||
|
||||
def detect(stream):
|
||||
"""Returns True if given stream is valid TSV."""
|
||||
try:
|
||||
rows = dialect = csv.Sniffer().sniff(stream, delimiters='\t')
|
||||
return True
|
||||
except csv.Error:
|
||||
return False
|
||||
@@ -0,0 +1,82 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - XLS Support.
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
from tablib.compat import BytesIO, xlwt
|
||||
|
||||
|
||||
title = 'xls'
|
||||
extentions = ('xls',)
|
||||
|
||||
# special styles
|
||||
wrap = xlwt.easyxf("alignment: wrap on")
|
||||
bold = xlwt.easyxf("font: bold on")
|
||||
|
||||
|
||||
def export_set(dataset):
|
||||
"""Returns XLS representation of Dataset."""
|
||||
|
||||
wb = xlwt.Workbook(encoding='utf8')
|
||||
ws = wb.add_sheet(dataset.title if dataset.title else 'Tablib Dataset')
|
||||
|
||||
dset_sheet(dataset, ws)
|
||||
|
||||
stream = BytesIO()
|
||||
wb.save(stream)
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def export_book(databook):
|
||||
"""Returns XLS representation of DataBook."""
|
||||
|
||||
wb = xlwt.Workbook(encoding='utf8')
|
||||
|
||||
for i, dset in enumerate(databook._datasets):
|
||||
ws = wb.add_sheet(dset.title if dset.title else 'Sheet%s' % (i))
|
||||
|
||||
dset_sheet(dset, ws)
|
||||
|
||||
|
||||
stream = BytesIO()
|
||||
wb.save(stream)
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def dset_sheet(dataset, ws):
|
||||
"""Completes given worksheet from given Dataset."""
|
||||
_package = dataset._package(dicts=False)
|
||||
|
||||
for i, sep in enumerate(dataset._separators):
|
||||
_offset = i
|
||||
_package.insert((sep[0] + _offset), (sep[1],))
|
||||
|
||||
for i, row in enumerate(_package):
|
||||
for j, col in enumerate(row):
|
||||
|
||||
# bold headers
|
||||
if (i == 0) and dataset.headers:
|
||||
ws.write(i, j, col, bold)
|
||||
|
||||
# frozen header row
|
||||
ws.panes_frozen = True
|
||||
ws.horz_split_pos = 1
|
||||
|
||||
|
||||
# bold separators
|
||||
elif len(row) < dataset.width:
|
||||
ws.write(i, j, col, bold)
|
||||
|
||||
# wrap the rest
|
||||
else:
|
||||
try:
|
||||
if '\n' in col:
|
||||
ws.write(i, j, col, wrap)
|
||||
else:
|
||||
ws.write(i, j, col)
|
||||
except TypeError:
|
||||
ws.write(i, j, col)
|
||||
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - XLSX Support.
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
|
||||
if sys.version_info[0] > 2:
|
||||
from io import BytesIO
|
||||
else:
|
||||
from cStringIO import StringIO as BytesIO
|
||||
|
||||
from tablib.compat import openpyxl
|
||||
|
||||
Workbook = openpyxl.workbook.Workbook
|
||||
ExcelWriter = openpyxl.writer.excel.ExcelWriter
|
||||
get_column_letter = openpyxl.cell.get_column_letter
|
||||
|
||||
from tablib.compat import unicode
|
||||
|
||||
|
||||
title = 'xlsx'
|
||||
extentions = ('xlsx',)
|
||||
|
||||
def export_set(dataset):
|
||||
"""Returns XLSX representation of Dataset."""
|
||||
|
||||
wb = Workbook()
|
||||
ws = wb.worksheets[0]
|
||||
ws.title = dataset.title if dataset.title else 'Tablib Dataset'
|
||||
|
||||
dset_sheet(dataset, ws)
|
||||
|
||||
stream = BytesIO()
|
||||
wb.save(stream)
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def export_book(databook):
|
||||
"""Returns XLSX representation of DataBook."""
|
||||
|
||||
wb = Workbook()
|
||||
ew = ExcelWriter(workbook = wb)
|
||||
for i, dset in enumerate(databook._datasets):
|
||||
ws = wb.create_sheet()
|
||||
ws.title = dset.title if dset.title else 'Sheet%s' % (i)
|
||||
|
||||
dset_sheet(dset, ws)
|
||||
|
||||
|
||||
stream = BytesIO()
|
||||
ew.save(stream)
|
||||
return stream.getvalue()
|
||||
|
||||
|
||||
def dset_sheet(dataset, ws):
|
||||
"""Completes given worksheet from given Dataset."""
|
||||
_package = dataset._package(dicts=False)
|
||||
|
||||
for i, sep in enumerate(dataset._separators):
|
||||
_offset = i
|
||||
_package.insert((sep[0] + _offset), (sep[1],))
|
||||
|
||||
for i, row in enumerate(_package):
|
||||
row_number = i + 1
|
||||
for j, col in enumerate(row):
|
||||
col_idx = get_column_letter(j + 1)
|
||||
|
||||
# bold headers
|
||||
if (row_number == 1) and dataset.headers:
|
||||
# ws.cell('%s%s'%(col_idx, row_number)).value = unicode(
|
||||
# '%s' % col, errors='ignore')
|
||||
ws.cell('%s%s'%(col_idx, row_number)).value = unicode(col)
|
||||
style = ws.get_style('%s%s' % (col_idx, row_number))
|
||||
style.font.bold = True
|
||||
ws.freeze_panes = '%s%s' % (col_idx, row_number)
|
||||
|
||||
|
||||
# bold separators
|
||||
elif len(row) < dataset.width:
|
||||
ws.cell('%s%s'%(col_idx, row_number)).value = unicode(
|
||||
'%s' % col, errors='ignore')
|
||||
style = ws.get_style('%s%s' % (col_idx, row_number))
|
||||
style.font.bold = True
|
||||
|
||||
# wrap the rest
|
||||
else:
|
||||
try:
|
||||
if '\n' in col:
|
||||
ws.cell('%s%s'%(col_idx, row_number)).value = unicode(
|
||||
'%s' % col, errors='ignore')
|
||||
style = ws.get_style('%s%s' % (col_idx, row_number))
|
||||
style.alignment.wrap_text
|
||||
else:
|
||||
ws.cell('%s%s'%(col_idx, row_number)).value = unicode(
|
||||
'%s' % col, errors='ignore')
|
||||
except TypeError:
|
||||
ws.cell('%s%s'%(col_idx, row_number)).value = unicode(col)
|
||||
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
""" Tablib - YAML Support.
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
try:
|
||||
import yaml
|
||||
except ImportError:
|
||||
if sys.version_info[0] > 2:
|
||||
import tablib.packages.yaml3 as yaml
|
||||
else:
|
||||
import tablib.packages.yaml as yaml
|
||||
|
||||
|
||||
import tablib
|
||||
|
||||
|
||||
|
||||
title = 'yaml'
|
||||
extentions = ('yaml', 'yml')
|
||||
|
||||
|
||||
|
||||
def export_set(dataset):
|
||||
"""Returns YAML representation of Dataset."""
|
||||
return yaml.dump(dataset.dict)
|
||||
|
||||
|
||||
def export_book(databook):
|
||||
"""Returns YAML representation of Databook."""
|
||||
return yaml.dump(databook._package())
|
||||
|
||||
|
||||
def import_set(dset, in_stream):
|
||||
"""Returns dataset from YAML stream."""
|
||||
|
||||
dset.wipe()
|
||||
dset.dict = yaml.load(in_stream)
|
||||
|
||||
|
||||
def import_book(dbook, in_stream):
|
||||
"""Returns databook from YAML stream."""
|
||||
|
||||
dbook.wipe()
|
||||
|
||||
for sheet in yaml.load(in_stream):
|
||||
data = tablib.Dataset()
|
||||
data.title = sheet['title']
|
||||
data.dict = sheet['data']
|
||||
dbook.add_sheet(data)
|
||||
|
||||
def detect(stream):
|
||||
"""Returns True if given stream is valid YAML."""
|
||||
try:
|
||||
_yaml = yaml.load(stream)
|
||||
if isinstance(_yaml, (list, tuple, dict)):
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
except yaml.parser.ParserError:
|
||||
return False
|
||||
@@ -1,20 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
import sys
|
||||
|
||||
|
||||
class Object(object):
|
||||
"""Your attributes are belong to us."""
|
||||
|
||||
def __init__(self, **entries):
|
||||
self.__dict__.update(entries)
|
||||
|
||||
def __getitem__(self, key):
|
||||
return getattr(self, key)
|
||||
|
||||
|
||||
def piped():
|
||||
"""Returns piped input via stdin, else False"""
|
||||
|
||||
with sys.stdin as stdin:
|
||||
return stdin.read() if not stdin.isatty() else None
|
||||
@@ -1 +0,0 @@
|
||||
all = ['simplejson', 'typecheck', 'xlwt', 'opster']
|
||||
@@ -0,0 +1,117 @@
|
||||
"""
|
||||
Wraps the best available JSON implementation available in a common interface
|
||||
"""
|
||||
|
||||
__version__ = "0.2.0"
|
||||
__author__ = "Rune Halvorsen <runefh@gmail.com>"
|
||||
__homepage__ = "http://bitbucket.org/runeh/anyjson/"
|
||||
__docformat__ = "restructuredtext"
|
||||
|
||||
"""
|
||||
|
||||
.. function:: serialize(obj)
|
||||
|
||||
Serialize the object to JSON.
|
||||
|
||||
.. function:: deserialize(str)
|
||||
|
||||
Deserialize JSON-encoded object to a Python object.
|
||||
|
||||
.. function:: force_implementation(name)
|
||||
|
||||
Load a specific json module. This is useful for testing and not much else
|
||||
|
||||
.. attribute:: implementation
|
||||
|
||||
The json implementation object. This is probably not useful to you,
|
||||
except to get the name of the implementation in use. The name is
|
||||
available through `implementation.name`.
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
implementation = None
|
||||
|
||||
"""
|
||||
.. data:: _modules
|
||||
|
||||
List of known json modules, and the names of their serialize/unserialize
|
||||
methods, as well as the exception they throw. Exception can be either
|
||||
an exception class or a string.
|
||||
"""
|
||||
_modules = [("cjson", "encode", "EncodeError", "decode", "DecodeError"),
|
||||
("jsonlib2", "write", "WriteError", "read", "ReadError"),
|
||||
("jsonlib", "write", "WriteError", "read", "ReadError"),
|
||||
("simplejson", "dumps", TypeError, "loads", ValueError),
|
||||
("json", "dumps", TypeError, "loads", ValueError),
|
||||
("django.utils.simplejson", "dumps", TypeError, "loads",
|
||||
ValueError)]
|
||||
_fields = ("modname", "encoder", "encerror", "decoder", "decerror")
|
||||
|
||||
|
||||
class _JsonImplementation(object):
|
||||
"""Incapsulates a JSON implementation"""
|
||||
|
||||
def __init__(self, modspec):
|
||||
modinfo = dict(list(zip(_fields, modspec)))
|
||||
|
||||
# No try block. We want importerror to end up at caller
|
||||
module = self._attempt_load(modinfo["modname"])
|
||||
|
||||
self.implementation = modinfo["modname"]
|
||||
self._encode = getattr(module, modinfo["encoder"])
|
||||
self._decode = getattr(module, modinfo["decoder"])
|
||||
self._encode_error = modinfo["encerror"]
|
||||
self._decode_error = modinfo["decerror"]
|
||||
|
||||
if isinstance(modinfo["encerror"], str):
|
||||
self._encode_error = getattr(module, modinfo["encerror"])
|
||||
if isinstance(modinfo["decerror"], str):
|
||||
self._decode_error = getattr(module, modinfo["decerror"])
|
||||
|
||||
self.name = modinfo["modname"]
|
||||
|
||||
def _attempt_load(self, modname):
|
||||
"""Attempt to load module name modname, returning it on success,
|
||||
throwing ImportError if module couldn't be imported"""
|
||||
__import__(modname)
|
||||
return sys.modules[modname]
|
||||
|
||||
def serialize(self, data):
|
||||
"""Serialize the datastructure to json. Returns a string. Raises
|
||||
TypeError if the object could not be serialized."""
|
||||
try:
|
||||
return self._encode(data)
|
||||
except self._encode_error as exc:
|
||||
raise TypeError(*exc.args)
|
||||
|
||||
def deserialize(self, s):
|
||||
"""deserialize the string to python data types. Raises
|
||||
ValueError if the string vould not be parsed."""
|
||||
try:
|
||||
return self._decode(s)
|
||||
except self._decode_error as exc:
|
||||
raise ValueError(*exc.args)
|
||||
|
||||
|
||||
def force_implementation(modname):
|
||||
"""Forces anyjson to use a specific json module if it's available"""
|
||||
global implementation
|
||||
for name, spec in [(e[0], e) for e in _modules]:
|
||||
if name == modname:
|
||||
implementation = _JsonImplementation(spec)
|
||||
return
|
||||
raise ImportError("No module named: %s" % modname)
|
||||
|
||||
|
||||
for modspec in _modules:
|
||||
try:
|
||||
implementation = _JsonImplementation(modspec)
|
||||
break
|
||||
except ImportError:
|
||||
pass
|
||||
else:
|
||||
raise ImportError("No supported JSON module found")
|
||||
|
||||
serialize = lambda value: implementation.serialize(value)
|
||||
deserialize = lambda value: implementation.deserialize(value)
|
||||
@@ -0,0 +1,118 @@
|
||||
u"""
|
||||
Wraps the best available JSON implementation available in a common interface
|
||||
"""
|
||||
|
||||
__version__ = u"0.2.0"
|
||||
__author__ = u"Rune Halvorsen <runefh@gmail.com>"
|
||||
__homepage__ = u"http://bitbucket.org/runeh/anyjson/"
|
||||
__docformat__ = u"restructuredtext"
|
||||
|
||||
u"""
|
||||
|
||||
.. function:: serialize(obj)
|
||||
|
||||
Serialize the object to JSON.
|
||||
|
||||
.. function:: deserialize(str)
|
||||
|
||||
Deserialize JSON-encoded object to a Python object.
|
||||
|
||||
.. function:: force_implementation(name)
|
||||
|
||||
Load a specific json module. This is useful for testing and not much else
|
||||
|
||||
.. attribute:: implementation
|
||||
|
||||
The json implementation object. This is probably not useful to you,
|
||||
except to get the name of the implementation in use. The name is
|
||||
available through `implementation.name`.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from itertools import izip
|
||||
|
||||
implementation = None
|
||||
|
||||
u"""
|
||||
.. data:: _modules
|
||||
|
||||
List of known json modules, and the names of their serialize/unserialize
|
||||
methods, as well as the exception they throw. Exception can be either
|
||||
an exception class or a string.
|
||||
"""
|
||||
_modules = [(u"cjson", u"encode", u"EncodeError", u"decode", u"DecodeError"),
|
||||
(u"jsonlib2", u"write", u"WriteError", u"read", u"ReadError"),
|
||||
(u"jsonlib", u"write", u"WriteError", u"read", u"ReadError"),
|
||||
(u"simplejson", u"dumps", TypeError, u"loads", ValueError),
|
||||
(u"json", u"dumps", TypeError, u"loads", ValueError),
|
||||
(u"django.utils.simplejson", u"dumps", TypeError, u"loads",
|
||||
ValueError)]
|
||||
_fields = (u"modname", u"encoder", u"encerror", u"decoder", u"decerror")
|
||||
|
||||
|
||||
class _JsonImplementation(object):
|
||||
u"""Incapsulates a JSON implementation"""
|
||||
|
||||
def __init__(self, modspec):
|
||||
modinfo = dict(list(izip(_fields, modspec)))
|
||||
|
||||
# No try block. We want importerror to end up at caller
|
||||
module = self._attempt_load(modinfo[u"modname"])
|
||||
|
||||
self.implementation = modinfo[u"modname"]
|
||||
self._encode = getattr(module, modinfo[u"encoder"])
|
||||
self._decode = getattr(module, modinfo[u"decoder"])
|
||||
self._encode_error = modinfo[u"encerror"]
|
||||
self._decode_error = modinfo[u"decerror"]
|
||||
|
||||
if isinstance(modinfo[u"encerror"], unicode):
|
||||
self._encode_error = getattr(module, modinfo[u"encerror"])
|
||||
if isinstance(modinfo[u"decerror"], unicode):
|
||||
self._decode_error = getattr(module, modinfo[u"decerror"])
|
||||
|
||||
self.name = modinfo[u"modname"]
|
||||
|
||||
def _attempt_load(self, modname):
|
||||
u"""Attempt to load module name modname, returning it on success,
|
||||
throwing ImportError if module couldn't be imported"""
|
||||
__import__(modname)
|
||||
return sys.modules[modname]
|
||||
|
||||
def serialize(self, data):
|
||||
u"""Serialize the datastructure to json. Returns a string. Raises
|
||||
TypeError if the object could not be serialized."""
|
||||
try:
|
||||
return self._encode(data)
|
||||
except self._encode_error, exc:
|
||||
raise TypeError(*exc.args)
|
||||
|
||||
def deserialize(self, s):
|
||||
u"""deserialize the string to python data types. Raises
|
||||
ValueError if the string vould not be parsed."""
|
||||
try:
|
||||
return self._decode(s)
|
||||
except self._decode_error, exc:
|
||||
raise ValueError(*exc.args)
|
||||
|
||||
|
||||
def force_implementation(modname):
|
||||
u"""Forces anyjson to use a specific json module if it's available"""
|
||||
global implementation
|
||||
for name, spec in [(e[0], e) for e in _modules]:
|
||||
if name == modname:
|
||||
implementation = _JsonImplementation(spec)
|
||||
return
|
||||
raise ImportError(u"No module named: %s" % modname)
|
||||
|
||||
|
||||
for modspec in _modules:
|
||||
try:
|
||||
implementation = _JsonImplementation(modspec)
|
||||
break
|
||||
except ImportError:
|
||||
pass
|
||||
else:
|
||||
raise ImportError(u"No supported JSON module found")
|
||||
|
||||
serialize = lambda value: implementation.serialize(value)
|
||||
deserialize = lambda value: implementation.deserialize(value)
|
||||
@@ -0,0 +1,484 @@
|
||||
# This code is in the public domain, it comes
|
||||
# with absolutely no warranty and you can do
|
||||
# absolutely whatever you want with it.
|
||||
|
||||
__date__ = '17 May 2007'
|
||||
__version__ = '1.7'
|
||||
__doc__= """
|
||||
This is markup.py - a Python module that attempts to
|
||||
make it easier to generate HTML/XML from a Python program
|
||||
in an intuitive, lightweight, customizable and pythonic way.
|
||||
|
||||
The code is in the public domain.
|
||||
|
||||
Version: %s as of %s.
|
||||
|
||||
Documentation and further info is at http://markup.sourceforge.net/
|
||||
|
||||
Please send bug reports, feature requests, enhancement
|
||||
ideas or questions to nogradi at gmail dot com.
|
||||
|
||||
Installation: drop markup.py somewhere into your Python path.
|
||||
""" % ( __version__, __date__ )
|
||||
|
||||
import string
|
||||
|
||||
class element:
|
||||
"""This class handles the addition of a new element."""
|
||||
|
||||
def __init__( self, tag, case='lower', parent=None ):
|
||||
self.parent = parent
|
||||
|
||||
if case == 'lower':
|
||||
self.tag = tag.lower( )
|
||||
else:
|
||||
self.tag = tag.upper( )
|
||||
|
||||
def __call__( self, *args, **kwargs ):
|
||||
if len( args ) > 1:
|
||||
raise ArgumentError( self.tag )
|
||||
|
||||
# if class_ was defined in parent it should be added to every element
|
||||
if self.parent is not None and self.parent.class_ is not None:
|
||||
if 'class_' not in kwargs:
|
||||
kwargs['class_'] = self.parent.class_
|
||||
|
||||
if self.parent is None and len( args ) == 1:
|
||||
x = [ self.render( self.tag, False, myarg, mydict ) for myarg, mydict in _argsdicts( args, kwargs ) ]
|
||||
return '\n'.join( x )
|
||||
elif self.parent is None and len( args ) == 0:
|
||||
x = [ self.render( self.tag, True, myarg, mydict ) for myarg, mydict in _argsdicts( args, kwargs ) ]
|
||||
return '\n'.join( x )
|
||||
|
||||
if self.tag in self.parent.twotags:
|
||||
for myarg, mydict in _argsdicts( args, kwargs ):
|
||||
self.render( self.tag, False, myarg, mydict )
|
||||
elif self.tag in self.parent.onetags:
|
||||
if len( args ) == 0:
|
||||
for myarg, mydict in _argsdicts( args, kwargs ):
|
||||
self.render( self.tag, True, myarg, mydict ) # here myarg is always None, because len( args ) = 0
|
||||
else:
|
||||
raise ClosingError( self.tag )
|
||||
elif self.parent.mode == 'strict_html' and self.tag in self.parent.deptags:
|
||||
raise DeprecationError( self.tag )
|
||||
else:
|
||||
raise InvalidElementError( self.tag, self.parent.mode )
|
||||
|
||||
def render( self, tag, single, between, kwargs ):
|
||||
"""Append the actual tags to content."""
|
||||
|
||||
out = "<%s" % tag
|
||||
for key, value in kwargs.iteritems( ):
|
||||
if value is not None: # when value is None that means stuff like <... checked>
|
||||
key = key.strip('_') # strip this so class_ will mean class, etc.
|
||||
if key == 'http_equiv': # special cases, maybe change _ to - overall?
|
||||
key = 'http-equiv'
|
||||
elif key == 'accept_charset':
|
||||
key = 'accept-charset'
|
||||
out = "%s %s=\"%s\"" % ( out, key, escape( value ) )
|
||||
else:
|
||||
out = "%s %s" % ( out, key )
|
||||
if between is not None:
|
||||
out = "%s>%s</%s>" % ( out, between, tag )
|
||||
else:
|
||||
if single:
|
||||
out = "%s />" % out
|
||||
else:
|
||||
out = "%s>" % out
|
||||
if self.parent is not None:
|
||||
self.parent.content.append( out )
|
||||
else:
|
||||
return out
|
||||
|
||||
def close( self ):
|
||||
"""Append a closing tag unless element has only opening tag."""
|
||||
|
||||
if self.tag in self.parent.twotags:
|
||||
self.parent.content.append( "</%s>" % self.tag )
|
||||
elif self.tag in self.parent.onetags:
|
||||
raise ClosingError( self.tag )
|
||||
elif self.parent.mode == 'strict_html' and self.tag in self.parent.deptags:
|
||||
raise DeprecationError( self.tag )
|
||||
|
||||
def open( self, **kwargs ):
|
||||
"""Append an opening tag."""
|
||||
|
||||
if self.tag in self.parent.twotags or self.tag in self.parent.onetags:
|
||||
self.render( self.tag, False, None, kwargs )
|
||||
elif self.mode == 'strict_html' and self.tag in self.parent.deptags:
|
||||
raise DeprecationError( self.tag )
|
||||
|
||||
class page:
|
||||
"""This is our main class representing a document. Elements are added
|
||||
as attributes of an instance of this class."""
|
||||
|
||||
def __init__( self, mode='strict_html', case='lower', onetags=None, twotags=None, separator='\n', class_=None ):
|
||||
"""Stuff that effects the whole document.
|
||||
|
||||
mode -- 'strict_html' for HTML 4.01 (default)
|
||||
'html' alias for 'strict_html'
|
||||
'loose_html' to allow some deprecated elements
|
||||
'xml' to allow arbitrary elements
|
||||
|
||||
case -- 'lower' element names will be printed in lower case (default)
|
||||
'upper' they will be printed in upper case
|
||||
|
||||
onetags -- list or tuple of valid elements with opening tags only
|
||||
twotags -- list or tuple of valid elements with both opening and closing tags
|
||||
these two keyword arguments may be used to select
|
||||
the set of valid elements in 'xml' mode
|
||||
invalid elements will raise appropriate exceptions
|
||||
|
||||
separator -- string to place between added elements, defaults to newline
|
||||
|
||||
class_ -- a class that will be added to every element if defined"""
|
||||
|
||||
valid_onetags = [ "AREA", "BASE", "BR", "COL", "FRAME", "HR", "IMG", "INPUT", "LINK", "META", "PARAM" ]
|
||||
valid_twotags = [ "A", "ABBR", "ACRONYM", "ADDRESS", "B", "BDO", "BIG", "BLOCKQUOTE", "BODY", "BUTTON",
|
||||
"CAPTION", "CITE", "CODE", "COLGROUP", "DD", "DEL", "DFN", "DIV", "DL", "DT", "EM", "FIELDSET",
|
||||
"FORM", "FRAMESET", "H1", "H2", "H3", "H4", "H5", "H6", "HEAD", "HTML", "I", "IFRAME", "INS",
|
||||
"KBD", "LABEL", "LEGEND", "LI", "MAP", "NOFRAMES", "NOSCRIPT", "OBJECT", "OL", "OPTGROUP",
|
||||
"OPTION", "P", "PRE", "Q", "SAMP", "SCRIPT", "SELECT", "SMALL", "SPAN", "STRONG", "STYLE",
|
||||
"SUB", "SUP", "TABLE", "TBODY", "TD", "TEXTAREA", "TFOOT", "TH", "THEAD", "TITLE", "TR",
|
||||
"TT", "UL", "VAR" ]
|
||||
deprecated_onetags = [ "BASEFONT", "ISINDEX" ]
|
||||
deprecated_twotags = [ "APPLET", "CENTER", "DIR", "FONT", "MENU", "S", "STRIKE", "U" ]
|
||||
|
||||
self.header = [ ]
|
||||
self.content = [ ]
|
||||
self.footer = [ ]
|
||||
self.case = case
|
||||
self.separator = separator
|
||||
|
||||
# init( ) sets it to True so we know that </body></html> has to be printed at the end
|
||||
self._full = False
|
||||
self.class_= class_
|
||||
|
||||
if mode == 'strict_html' or mode == 'html':
|
||||
self.onetags = valid_onetags
|
||||
self.onetags += map( string.lower, self.onetags )
|
||||
self.twotags = valid_twotags
|
||||
self.twotags += map( string.lower, self.twotags )
|
||||
self.deptags = deprecated_onetags + deprecated_twotags
|
||||
self.deptags += map( string.lower, self.deptags )
|
||||
self.mode = 'strict_html'
|
||||
elif mode == 'loose_html':
|
||||
self.onetags = valid_onetags + deprecated_onetags
|
||||
self.onetags += map( string.lower, self.onetags )
|
||||
self.twotags = valid_twotags + deprecated_twotags
|
||||
self.twotags += map( string.lower, self.twotags )
|
||||
self.mode = mode
|
||||
elif mode == 'xml':
|
||||
if onetags and twotags:
|
||||
self.onetags = onetags
|
||||
self.twotags = twotags
|
||||
elif ( onetags and not twotags ) or ( twotags and not onetags ):
|
||||
raise CustomizationError( )
|
||||
else:
|
||||
self.onetags = russell( )
|
||||
self.twotags = russell( )
|
||||
self.mode = mode
|
||||
else:
|
||||
raise ModeError( mode )
|
||||
|
||||
def __getattr__( self, attr ):
|
||||
if attr.startswith("__") and attr.endswith("__"):
|
||||
raise AttributeError, attr
|
||||
return element( attr, case=self.case, parent=self )
|
||||
|
||||
def __str__( self ):
|
||||
|
||||
if self._full and ( self.mode == 'strict_html' or self.mode == 'loose_html' ):
|
||||
end = [ '</body>', '</html>' ]
|
||||
else:
|
||||
end = [ ]
|
||||
|
||||
return self.separator.join( self.header + self.content + self.footer + end )
|
||||
|
||||
def __call__( self, escape=False ):
|
||||
"""Return the document as a string.
|
||||
|
||||
escape -- False print normally
|
||||
True replace < and > by < and >
|
||||
the default escape sequences in most browsers"""
|
||||
|
||||
if escape:
|
||||
return _escape( self.__str__( ) )
|
||||
else:
|
||||
return self.__str__( )
|
||||
|
||||
def add( self, text ):
|
||||
"""This is an alias to addcontent."""
|
||||
self.addcontent( text )
|
||||
|
||||
def addfooter( self, text ):
|
||||
"""Add some text to the bottom of the document"""
|
||||
self.footer.append( text )
|
||||
|
||||
def addheader( self, text ):
|
||||
"""Add some text to the top of the document"""
|
||||
self.header.append( text )
|
||||
|
||||
def addcontent( self, text ):
|
||||
"""Add some text to the main part of the document"""
|
||||
self.content.append( text )
|
||||
|
||||
|
||||
def init( self, lang='en', css=None, metainfo=None, title=None, header=None,
|
||||
footer=None, charset=None, encoding=None, doctype=None, bodyattrs=None, script=None ):
|
||||
"""This method is used for complete documents with appropriate
|
||||
doctype, encoding, title, etc information. For an HTML/XML snippet
|
||||
omit this method.
|
||||
|
||||
lang -- language, usually a two character string, will appear
|
||||
as <html lang='en'> in html mode (ignored in xml mode)
|
||||
|
||||
css -- Cascading Style Sheet filename as a string or a list of
|
||||
strings for multiple css files (ignored in xml mode)
|
||||
|
||||
metainfo -- a dictionary in the form { 'name':'content' } to be inserted
|
||||
into meta element(s) as <meta name='name' content='content'>
|
||||
(ignored in xml mode)
|
||||
|
||||
bodyattrs --a dictionary in the form { 'key':'value', ... } which will be added
|
||||
as attributes of the <body> element as <body key='value' ... >
|
||||
(ignored in xml mode)
|
||||
|
||||
script -- dictionary containing src:type pairs, <script type='text/type' src=src></script>
|
||||
|
||||
title -- the title of the document as a string to be inserted into
|
||||
a title element as <title>my title</title> (ignored in xml mode)
|
||||
|
||||
header -- some text to be inserted right after the <body> element
|
||||
(ignored in xml mode)
|
||||
|
||||
footer -- some text to be inserted right before the </body> element
|
||||
(ignored in xml mode)
|
||||
|
||||
charset -- a string defining the character set, will be inserted into a
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=myset'>
|
||||
element (ignored in xml mode)
|
||||
|
||||
encoding -- a string defining the encoding, will be put into to first line of
|
||||
the document as <?xml version='1.0' encoding='myencoding' ?> in
|
||||
xml mode (ignored in html mode)
|
||||
|
||||
doctype -- the document type string, defaults to
|
||||
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>
|
||||
in html mode (ignored in xml mode)"""
|
||||
|
||||
self._full = True
|
||||
|
||||
if self.mode == 'strict_html' or self.mode == 'loose_html':
|
||||
if doctype is None:
|
||||
doctype = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>"
|
||||
self.header.append( doctype )
|
||||
self.html( lang=lang )
|
||||
self.head( )
|
||||
if charset is not None:
|
||||
self.meta( http_equiv='Content-Type', content="text/html; charset=%s" % charset )
|
||||
if metainfo is not None:
|
||||
self.metainfo( metainfo )
|
||||
if css is not None:
|
||||
self.css( css )
|
||||
if title is not None:
|
||||
self.title( title )
|
||||
if script is not None:
|
||||
self.scripts( script )
|
||||
self.head.close()
|
||||
if bodyattrs is not None:
|
||||
self.body( **bodyattrs )
|
||||
else:
|
||||
self.body( )
|
||||
if header is not None:
|
||||
self.content.append( header )
|
||||
if footer is not None:
|
||||
self.footer.append( footer )
|
||||
|
||||
elif self.mode == 'xml':
|
||||
if doctype is None:
|
||||
if encoding is not None:
|
||||
doctype = "<?xml version='1.0' encoding='%s' ?>" % encoding
|
||||
else:
|
||||
doctype = "<?xml version='1.0' ?>"
|
||||
self.header.append( doctype )
|
||||
|
||||
def css( self, filelist ):
|
||||
"""This convenience function is only useful for html.
|
||||
It adds css stylesheet(s) to the document via the <link> element."""
|
||||
|
||||
if isinstance( filelist, basestring ):
|
||||
self.link( href=filelist, rel='stylesheet', type='text/css', media='all' )
|
||||
else:
|
||||
for file in filelist:
|
||||
self.link( href=file, rel='stylesheet', type='text/css', media='all' )
|
||||
|
||||
def metainfo( self, mydict ):
|
||||
"""This convenience function is only useful for html.
|
||||
It adds meta information via the <meta> element, the argument is
|
||||
a dictionary of the form { 'name':'content' }."""
|
||||
|
||||
if isinstance( mydict, dict ):
|
||||
for name, content in mydict.iteritems( ):
|
||||
self.meta( name=name, content=content )
|
||||
else:
|
||||
raise TypeError, "Metainfo should be called with a dictionary argument of name:content pairs."
|
||||
|
||||
def scripts( self, mydict ):
|
||||
"""Only useful in html, mydict is dictionary of src:type pairs will
|
||||
be rendered as <script type='text/type' src=src></script>"""
|
||||
|
||||
if isinstance( mydict, dict ):
|
||||
for src, type in mydict.iteritems( ):
|
||||
self.script( '', src=src, type='text/%s' % type )
|
||||
else:
|
||||
raise TypeError, "Script should be given a dictionary of src:type pairs."
|
||||
|
||||
|
||||
class _oneliner:
|
||||
"""An instance of oneliner returns a string corresponding to one element.
|
||||
This class can be used to write 'oneliners' that return a string
|
||||
immediately so there is no need to instantiate the page class."""
|
||||
|
||||
def __init__( self, case='lower' ):
|
||||
self.case = case
|
||||
|
||||
def __getattr__( self, attr ):
|
||||
if attr.startswith("__") and attr.endswith("__"):
|
||||
raise AttributeError, attr
|
||||
return element( attr, case=self.case, parent=None )
|
||||
|
||||
oneliner = _oneliner( case='lower' )
|
||||
upper_oneliner = _oneliner( case='upper' )
|
||||
|
||||
def _argsdicts( args, mydict ):
|
||||
"""A utility generator that pads argument list and dictionary values, will only be called with len( args ) = 0, 1."""
|
||||
|
||||
if len( args ) == 0:
|
||||
args = None,
|
||||
elif len( args ) == 1:
|
||||
args = _totuple( args[0] )
|
||||
else:
|
||||
raise Exception, "We should have never gotten here."
|
||||
|
||||
mykeys = mydict.keys( )
|
||||
myvalues = map( _totuple, mydict.values( ) )
|
||||
|
||||
maxlength = max( map( len, [ args ] + myvalues ) )
|
||||
|
||||
for i in xrange( maxlength ):
|
||||
thisdict = { }
|
||||
for key, value in zip( mykeys, myvalues ):
|
||||
try:
|
||||
thisdict[ key ] = value[i]
|
||||
except IndexError:
|
||||
thisdict[ key ] = value[-1]
|
||||
try:
|
||||
thisarg = args[i]
|
||||
except IndexError:
|
||||
thisarg = args[-1]
|
||||
|
||||
yield thisarg, thisdict
|
||||
|
||||
def _totuple( x ):
|
||||
"""Utility stuff to convert string, int, float, None or anything to a usable tuple."""
|
||||
|
||||
if isinstance( x, basestring ):
|
||||
out = x,
|
||||
elif isinstance( x, ( int, float ) ):
|
||||
out = str( x ),
|
||||
elif x is None:
|
||||
out = None,
|
||||
else:
|
||||
out = tuple( x )
|
||||
|
||||
return out
|
||||
|
||||
def escape( text, newline=False ):
|
||||
"""Escape special html characters."""
|
||||
|
||||
if isinstance( text, basestring ):
|
||||
if '&' in text:
|
||||
text = text.replace( '&', '&' )
|
||||
if '>' in text:
|
||||
text = text.replace( '>', '>' )
|
||||
if '<' in text:
|
||||
text = text.replace( '<', '<' )
|
||||
if '\"' in text:
|
||||
text = text.replace( '\"', '"' )
|
||||
if '\'' in text:
|
||||
text = text.replace( '\'', '"' )
|
||||
if newline:
|
||||
if '\n' in text:
|
||||
text = text.replace( '\n', '<br>' )
|
||||
|
||||
return text
|
||||
|
||||
_escape = escape
|
||||
|
||||
def unescape( text ):
|
||||
"""Inverse of escape."""
|
||||
|
||||
if isinstance( text, basestring ):
|
||||
if '&' in text:
|
||||
text = text.replace( '&', '&' )
|
||||
if '>' in text:
|
||||
text = text.replace( '>', '>' )
|
||||
if '<' in text:
|
||||
text = text.replace( '<', '<' )
|
||||
if '"' in text:
|
||||
text = text.replace( '"', '\"' )
|
||||
|
||||
return text
|
||||
|
||||
class dummy:
|
||||
"""A dummy class for attaching attributes."""
|
||||
pass
|
||||
|
||||
doctype = dummy( )
|
||||
doctype.frameset = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Frameset//EN' 'http://www.w3.org/TR/html4/frameset.dtd'>"
|
||||
doctype.strict = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01//EN' 'http://www.w3.org/TR/html4/strict.dtd'>"
|
||||
doctype.loose = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>"
|
||||
|
||||
class russell:
|
||||
"""A dummy class that contains anything."""
|
||||
|
||||
def __contains__( self, item ):
|
||||
return True
|
||||
|
||||
|
||||
class MarkupError( Exception ):
|
||||
"""All our exceptions subclass this."""
|
||||
def __str__( self ):
|
||||
return self.message
|
||||
|
||||
class ClosingError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' does not accept non-keyword arguments (has no closing tag)." % tag
|
||||
|
||||
class OpeningError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' can not be opened." % tag
|
||||
|
||||
class ArgumentError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' was called with more than one non-keyword argument." % tag
|
||||
|
||||
class InvalidElementError( MarkupError ):
|
||||
def __init__( self, tag, mode ):
|
||||
self.message = "The element '%s' is not valid for your mode '%s'." % ( tag, mode )
|
||||
|
||||
class DeprecationError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' is deprecated, instantiate markup.page with mode='loose_html' to allow it." % tag
|
||||
|
||||
class ModeError( MarkupError ):
|
||||
def __init__( self, mode ):
|
||||
self.message = "Mode '%s' is invalid, possible values: strict_html, loose_html, xml." % mode
|
||||
|
||||
class CustomizationError( MarkupError ):
|
||||
def __init__( self ):
|
||||
self.message = "If you customize the allowed elements, you must define both types 'onetags' and 'twotags'."
|
||||
|
||||
if __name__ == '__main__':
|
||||
print __doc__
|
||||
@@ -0,0 +1,484 @@
|
||||
# This code is in the public domain, it comes
|
||||
# with absolutely no warranty and you can do
|
||||
# absolutely whatever you want with it.
|
||||
|
||||
__date__ = '17 May 2007'
|
||||
__version__ = '1.7'
|
||||
__doc__= """
|
||||
This is markup.py - a Python module that attempts to
|
||||
make it easier to generate HTML/XML from a Python program
|
||||
in an intuitive, lightweight, customizable and pythonic way.
|
||||
|
||||
The code is in the public domain.
|
||||
|
||||
Version: %s as of %s.
|
||||
|
||||
Documentation and further info is at http://markup.sourceforge.net/
|
||||
|
||||
Please send bug reports, feature requests, enhancement
|
||||
ideas or questions to nogradi at gmail dot com.
|
||||
|
||||
Installation: drop markup.py somewhere into your Python path.
|
||||
""" % ( __version__, __date__ )
|
||||
|
||||
import string
|
||||
|
||||
class element:
|
||||
"""This class handles the addition of a new element."""
|
||||
|
||||
def __init__( self, tag, case='lower', parent=None ):
|
||||
self.parent = parent
|
||||
|
||||
if case == 'lower':
|
||||
self.tag = tag.lower( )
|
||||
else:
|
||||
self.tag = tag.upper( )
|
||||
|
||||
def __call__( self, *args, **kwargs ):
|
||||
if len( args ) > 1:
|
||||
raise ArgumentError( self.tag )
|
||||
|
||||
# if class_ was defined in parent it should be added to every element
|
||||
if self.parent is not None and self.parent.class_ is not None:
|
||||
if 'class_' not in kwargs:
|
||||
kwargs['class_'] = self.parent.class_
|
||||
|
||||
if self.parent is None and len( args ) == 1:
|
||||
x = [ self.render( self.tag, False, myarg, mydict ) for myarg, mydict in _argsdicts( args, kwargs ) ]
|
||||
return '\n'.join( x )
|
||||
elif self.parent is None and len( args ) == 0:
|
||||
x = [ self.render( self.tag, True, myarg, mydict ) for myarg, mydict in _argsdicts( args, kwargs ) ]
|
||||
return '\n'.join( x )
|
||||
|
||||
if self.tag in self.parent.twotags:
|
||||
for myarg, mydict in _argsdicts( args, kwargs ):
|
||||
self.render( self.tag, False, myarg, mydict )
|
||||
elif self.tag in self.parent.onetags:
|
||||
if len( args ) == 0:
|
||||
for myarg, mydict in _argsdicts( args, kwargs ):
|
||||
self.render( self.tag, True, myarg, mydict ) # here myarg is always None, because len( args ) = 0
|
||||
else:
|
||||
raise ClosingError( self.tag )
|
||||
elif self.parent.mode == 'strict_html' and self.tag in self.parent.deptags:
|
||||
raise DeprecationError( self.tag )
|
||||
else:
|
||||
raise InvalidElementError( self.tag, self.parent.mode )
|
||||
|
||||
def render( self, tag, single, between, kwargs ):
|
||||
"""Append the actual tags to content."""
|
||||
|
||||
out = "<%s" % tag
|
||||
for key, value in kwargs.items( ):
|
||||
if value is not None: # when value is None that means stuff like <... checked>
|
||||
key = key.strip('_') # strip this so class_ will mean class, etc.
|
||||
if key == 'http_equiv': # special cases, maybe change _ to - overall?
|
||||
key = 'http-equiv'
|
||||
elif key == 'accept_charset':
|
||||
key = 'accept-charset'
|
||||
out = "%s %s=\"%s\"" % ( out, key, escape( value ) )
|
||||
else:
|
||||
out = "%s %s" % ( out, key )
|
||||
if between is not None:
|
||||
out = "%s>%s</%s>" % ( out, between, tag )
|
||||
else:
|
||||
if single:
|
||||
out = "%s />" % out
|
||||
else:
|
||||
out = "%s>" % out
|
||||
if self.parent is not None:
|
||||
self.parent.content.append( out )
|
||||
else:
|
||||
return out
|
||||
|
||||
def close( self ):
|
||||
"""Append a closing tag unless element has only opening tag."""
|
||||
|
||||
if self.tag in self.parent.twotags:
|
||||
self.parent.content.append( "</%s>" % self.tag )
|
||||
elif self.tag in self.parent.onetags:
|
||||
raise ClosingError( self.tag )
|
||||
elif self.parent.mode == 'strict_html' and self.tag in self.parent.deptags:
|
||||
raise DeprecationError( self.tag )
|
||||
|
||||
def open( self, **kwargs ):
|
||||
"""Append an opening tag."""
|
||||
|
||||
if self.tag in self.parent.twotags or self.tag in self.parent.onetags:
|
||||
self.render( self.tag, False, None, kwargs )
|
||||
elif self.mode == 'strict_html' and self.tag in self.parent.deptags:
|
||||
raise DeprecationError( self.tag )
|
||||
|
||||
class page:
|
||||
"""This is our main class representing a document. Elements are added
|
||||
as attributes of an instance of this class."""
|
||||
|
||||
def __init__( self, mode='strict_html', case='lower', onetags=None, twotags=None, separator='\n', class_=None ):
|
||||
"""Stuff that effects the whole document.
|
||||
|
||||
mode -- 'strict_html' for HTML 4.01 (default)
|
||||
'html' alias for 'strict_html'
|
||||
'loose_html' to allow some deprecated elements
|
||||
'xml' to allow arbitrary elements
|
||||
|
||||
case -- 'lower' element names will be printed in lower case (default)
|
||||
'upper' they will be printed in upper case
|
||||
|
||||
onetags -- list or tuple of valid elements with opening tags only
|
||||
twotags -- list or tuple of valid elements with both opening and closing tags
|
||||
these two keyword arguments may be used to select
|
||||
the set of valid elements in 'xml' mode
|
||||
invalid elements will raise appropriate exceptions
|
||||
|
||||
separator -- string to place between added elements, defaults to newline
|
||||
|
||||
class_ -- a class that will be added to every element if defined"""
|
||||
|
||||
valid_onetags = [ "AREA", "BASE", "BR", "COL", "FRAME", "HR", "IMG", "INPUT", "LINK", "META", "PARAM" ]
|
||||
valid_twotags = [ "A", "ABBR", "ACRONYM", "ADDRESS", "B", "BDO", "BIG", "BLOCKQUOTE", "BODY", "BUTTON",
|
||||
"CAPTION", "CITE", "CODE", "COLGROUP", "DD", "DEL", "DFN", "DIV", "DL", "DT", "EM", "FIELDSET",
|
||||
"FORM", "FRAMESET", "H1", "H2", "H3", "H4", "H5", "H6", "HEAD", "HTML", "I", "IFRAME", "INS",
|
||||
"KBD", "LABEL", "LEGEND", "LI", "MAP", "NOFRAMES", "NOSCRIPT", "OBJECT", "OL", "OPTGROUP",
|
||||
"OPTION", "P", "PRE", "Q", "SAMP", "SCRIPT", "SELECT", "SMALL", "SPAN", "STRONG", "STYLE",
|
||||
"SUB", "SUP", "TABLE", "TBODY", "TD", "TEXTAREA", "TFOOT", "TH", "THEAD", "TITLE", "TR",
|
||||
"TT", "UL", "VAR" ]
|
||||
deprecated_onetags = [ "BASEFONT", "ISINDEX" ]
|
||||
deprecated_twotags = [ "APPLET", "CENTER", "DIR", "FONT", "MENU", "S", "STRIKE", "U" ]
|
||||
|
||||
self.header = [ ]
|
||||
self.content = [ ]
|
||||
self.footer = [ ]
|
||||
self.case = case
|
||||
self.separator = separator
|
||||
|
||||
# init( ) sets it to True so we know that </body></html> has to be printed at the end
|
||||
self._full = False
|
||||
self.class_= class_
|
||||
|
||||
if mode == 'strict_html' or mode == 'html':
|
||||
self.onetags = valid_onetags
|
||||
self.onetags += list(map( str.lower, self.onetags ))
|
||||
self.twotags = valid_twotags
|
||||
self.twotags += list(map( str.lower, self.twotags ))
|
||||
self.deptags = deprecated_onetags + deprecated_twotags
|
||||
self.deptags += list(map( str.lower, self.deptags ))
|
||||
self.mode = 'strict_html'
|
||||
elif mode == 'loose_html':
|
||||
self.onetags = valid_onetags + deprecated_onetags
|
||||
self.onetags += list(map( str.lower, self.onetags ))
|
||||
self.twotags = valid_twotags + deprecated_twotags
|
||||
self.twotags += list(map( str.lower, self.twotags ))
|
||||
self.mode = mode
|
||||
elif mode == 'xml':
|
||||
if onetags and twotags:
|
||||
self.onetags = onetags
|
||||
self.twotags = twotags
|
||||
elif ( onetags and not twotags ) or ( twotags and not onetags ):
|
||||
raise CustomizationError( )
|
||||
else:
|
||||
self.onetags = russell( )
|
||||
self.twotags = russell( )
|
||||
self.mode = mode
|
||||
else:
|
||||
raise ModeError( mode )
|
||||
|
||||
def __getattr__( self, attr ):
|
||||
if attr.startswith("__") and attr.endswith("__"):
|
||||
raise AttributeError(attr)
|
||||
return element( attr, case=self.case, parent=self )
|
||||
|
||||
def __str__( self ):
|
||||
|
||||
if self._full and ( self.mode == 'strict_html' or self.mode == 'loose_html' ):
|
||||
end = [ '</body>', '</html>' ]
|
||||
else:
|
||||
end = [ ]
|
||||
|
||||
return self.separator.join( self.header + self.content + self.footer + end )
|
||||
|
||||
def __call__( self, escape=False ):
|
||||
"""Return the document as a string.
|
||||
|
||||
escape -- False print normally
|
||||
True replace < and > by < and >
|
||||
the default escape sequences in most browsers"""
|
||||
|
||||
if escape:
|
||||
return _escape( self.__str__( ) )
|
||||
else:
|
||||
return self.__str__( )
|
||||
|
||||
def add( self, text ):
|
||||
"""This is an alias to addcontent."""
|
||||
self.addcontent( text )
|
||||
|
||||
def addfooter( self, text ):
|
||||
"""Add some text to the bottom of the document"""
|
||||
self.footer.append( text )
|
||||
|
||||
def addheader( self, text ):
|
||||
"""Add some text to the top of the document"""
|
||||
self.header.append( text )
|
||||
|
||||
def addcontent( self, text ):
|
||||
"""Add some text to the main part of the document"""
|
||||
self.content.append( text )
|
||||
|
||||
|
||||
def init( self, lang='en', css=None, metainfo=None, title=None, header=None,
|
||||
footer=None, charset=None, encoding=None, doctype=None, bodyattrs=None, script=None ):
|
||||
"""This method is used for complete documents with appropriate
|
||||
doctype, encoding, title, etc information. For an HTML/XML snippet
|
||||
omit this method.
|
||||
|
||||
lang -- language, usually a two character string, will appear
|
||||
as <html lang='en'> in html mode (ignored in xml mode)
|
||||
|
||||
css -- Cascading Style Sheet filename as a string or a list of
|
||||
strings for multiple css files (ignored in xml mode)
|
||||
|
||||
metainfo -- a dictionary in the form { 'name':'content' } to be inserted
|
||||
into meta element(s) as <meta name='name' content='content'>
|
||||
(ignored in xml mode)
|
||||
|
||||
bodyattrs --a dictionary in the form { 'key':'value', ... } which will be added
|
||||
as attributes of the <body> element as <body key='value' ... >
|
||||
(ignored in xml mode)
|
||||
|
||||
script -- dictionary containing src:type pairs, <script type='text/type' src=src></script>
|
||||
|
||||
title -- the title of the document as a string to be inserted into
|
||||
a title element as <title>my title</title> (ignored in xml mode)
|
||||
|
||||
header -- some text to be inserted right after the <body> element
|
||||
(ignored in xml mode)
|
||||
|
||||
footer -- some text to be inserted right before the </body> element
|
||||
(ignored in xml mode)
|
||||
|
||||
charset -- a string defining the character set, will be inserted into a
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=myset'>
|
||||
element (ignored in xml mode)
|
||||
|
||||
encoding -- a string defining the encoding, will be put into to first line of
|
||||
the document as <?xml version='1.0' encoding='myencoding' ?> in
|
||||
xml mode (ignored in html mode)
|
||||
|
||||
doctype -- the document type string, defaults to
|
||||
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>
|
||||
in html mode (ignored in xml mode)"""
|
||||
|
||||
self._full = True
|
||||
|
||||
if self.mode == 'strict_html' or self.mode == 'loose_html':
|
||||
if doctype is None:
|
||||
doctype = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>"
|
||||
self.header.append( doctype )
|
||||
self.html( lang=lang )
|
||||
self.head( )
|
||||
if charset is not None:
|
||||
self.meta( http_equiv='Content-Type', content="text/html; charset=%s" % charset )
|
||||
if metainfo is not None:
|
||||
self.metainfo( metainfo )
|
||||
if css is not None:
|
||||
self.css( css )
|
||||
if title is not None:
|
||||
self.title( title )
|
||||
if script is not None:
|
||||
self.scripts( script )
|
||||
self.head.close()
|
||||
if bodyattrs is not None:
|
||||
self.body( **bodyattrs )
|
||||
else:
|
||||
self.body( )
|
||||
if header is not None:
|
||||
self.content.append( header )
|
||||
if footer is not None:
|
||||
self.footer.append( footer )
|
||||
|
||||
elif self.mode == 'xml':
|
||||
if doctype is None:
|
||||
if encoding is not None:
|
||||
doctype = "<?xml version='1.0' encoding='%s' ?>" % encoding
|
||||
else:
|
||||
doctype = "<?xml version='1.0' ?>"
|
||||
self.header.append( doctype )
|
||||
|
||||
def css( self, filelist ):
|
||||
"""This convenience function is only useful for html.
|
||||
It adds css stylesheet(s) to the document via the <link> element."""
|
||||
|
||||
if isinstance( filelist, str ):
|
||||
self.link( href=filelist, rel='stylesheet', type='text/css', media='all' )
|
||||
else:
|
||||
for file in filelist:
|
||||
self.link( href=file, rel='stylesheet', type='text/css', media='all' )
|
||||
|
||||
def metainfo( self, mydict ):
|
||||
"""This convenience function is only useful for html.
|
||||
It adds meta information via the <meta> element, the argument is
|
||||
a dictionary of the form { 'name':'content' }."""
|
||||
|
||||
if isinstance( mydict, dict ):
|
||||
for name, content in mydict.items( ):
|
||||
self.meta( name=name, content=content )
|
||||
else:
|
||||
raise TypeError("Metainfo should be called with a dictionary argument of name:content pairs.")
|
||||
|
||||
def scripts( self, mydict ):
|
||||
"""Only useful in html, mydict is dictionary of src:type pairs will
|
||||
be rendered as <script type='text/type' src=src></script>"""
|
||||
|
||||
if isinstance( mydict, dict ):
|
||||
for src, type in mydict.items( ):
|
||||
self.script( '', src=src, type='text/%s' % type )
|
||||
else:
|
||||
raise TypeError("Script should be given a dictionary of src:type pairs.")
|
||||
|
||||
|
||||
class _oneliner:
|
||||
"""An instance of oneliner returns a string corresponding to one element.
|
||||
This class can be used to write 'oneliners' that return a string
|
||||
immediately so there is no need to instantiate the page class."""
|
||||
|
||||
def __init__( self, case='lower' ):
|
||||
self.case = case
|
||||
|
||||
def __getattr__( self, attr ):
|
||||
if attr.startswith("__") and attr.endswith("__"):
|
||||
raise AttributeError(attr)
|
||||
return element( attr, case=self.case, parent=None )
|
||||
|
||||
oneliner = _oneliner( case='lower' )
|
||||
upper_oneliner = _oneliner( case='upper' )
|
||||
|
||||
def _argsdicts( args, mydict ):
|
||||
"""A utility generator that pads argument list and dictionary values, will only be called with len( args ) = 0, 1."""
|
||||
|
||||
if len( args ) == 0:
|
||||
args = None,
|
||||
elif len( args ) == 1:
|
||||
args = _totuple( args[0] )
|
||||
else:
|
||||
raise Exception("We should have never gotten here.")
|
||||
|
||||
mykeys = list(mydict.keys( ))
|
||||
myvalues = list(map( _totuple, list(mydict.values( )) ))
|
||||
|
||||
maxlength = max( list(map( len, [ args ] + myvalues )) )
|
||||
|
||||
for i in range( maxlength ):
|
||||
thisdict = { }
|
||||
for key, value in zip( mykeys, myvalues ):
|
||||
try:
|
||||
thisdict[ key ] = value[i]
|
||||
except IndexError:
|
||||
thisdict[ key ] = value[-1]
|
||||
try:
|
||||
thisarg = args[i]
|
||||
except IndexError:
|
||||
thisarg = args[-1]
|
||||
|
||||
yield thisarg, thisdict
|
||||
|
||||
def _totuple( x ):
|
||||
"""Utility stuff to convert string, int, float, None or anything to a usable tuple."""
|
||||
|
||||
if isinstance( x, str ):
|
||||
out = x,
|
||||
elif isinstance( x, ( int, float ) ):
|
||||
out = str( x ),
|
||||
elif x is None:
|
||||
out = None,
|
||||
else:
|
||||
out = tuple( x )
|
||||
|
||||
return out
|
||||
|
||||
def escape( text, newline=False ):
|
||||
"""Escape special html characters."""
|
||||
|
||||
if isinstance( text, str ):
|
||||
if '&' in text:
|
||||
text = text.replace( '&', '&' )
|
||||
if '>' in text:
|
||||
text = text.replace( '>', '>' )
|
||||
if '<' in text:
|
||||
text = text.replace( '<', '<' )
|
||||
if '\"' in text:
|
||||
text = text.replace( '\"', '"' )
|
||||
if '\'' in text:
|
||||
text = text.replace( '\'', '"' )
|
||||
if newline:
|
||||
if '\n' in text:
|
||||
text = text.replace( '\n', '<br>' )
|
||||
|
||||
return text
|
||||
|
||||
_escape = escape
|
||||
|
||||
def unescape( text ):
|
||||
"""Inverse of escape."""
|
||||
|
||||
if isinstance( text, str ):
|
||||
if '&' in text:
|
||||
text = text.replace( '&', '&' )
|
||||
if '>' in text:
|
||||
text = text.replace( '>', '>' )
|
||||
if '<' in text:
|
||||
text = text.replace( '<', '<' )
|
||||
if '"' in text:
|
||||
text = text.replace( '"', '\"' )
|
||||
|
||||
return text
|
||||
|
||||
class dummy:
|
||||
"""A dummy class for attaching attributes."""
|
||||
pass
|
||||
|
||||
doctype = dummy( )
|
||||
doctype.frameset = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Frameset//EN' 'http://www.w3.org/TR/html4/frameset.dtd'>"
|
||||
doctype.strict = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01//EN' 'http://www.w3.org/TR/html4/strict.dtd'>"
|
||||
doctype.loose = "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>"
|
||||
|
||||
class russell:
|
||||
"""A dummy class that contains anything."""
|
||||
|
||||
def __contains__( self, item ):
|
||||
return True
|
||||
|
||||
|
||||
class MarkupError( Exception ):
|
||||
"""All our exceptions subclass this."""
|
||||
def __str__( self ):
|
||||
return self.message
|
||||
|
||||
class ClosingError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' does not accept non-keyword arguments (has no closing tag)." % tag
|
||||
|
||||
class OpeningError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' can not be opened." % tag
|
||||
|
||||
class ArgumentError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' was called with more than one non-keyword argument." % tag
|
||||
|
||||
class InvalidElementError( MarkupError ):
|
||||
def __init__( self, tag, mode ):
|
||||
self.message = "The element '%s' is not valid for your mode '%s'." % ( tag, mode )
|
||||
|
||||
class DeprecationError( MarkupError ):
|
||||
def __init__( self, tag ):
|
||||
self.message = "The element '%s' is deprecated, instantiate markup.page with mode='loose_html' to allow it." % tag
|
||||
|
||||
class ModeError( MarkupError ):
|
||||
def __init__( self, mode ):
|
||||
self.message = "Mode '%s' is invalid, possible values: strict_html, loose_html, xml." % mode
|
||||
|
||||
class CustomizationError( MarkupError ):
|
||||
def __init__( self ):
|
||||
self.message = "If you customize the allowed elements, you must define both types 'onetags' and 'twotags'."
|
||||
|
||||
if __name__ == '__main__':
|
||||
print(__doc__)
|
||||
@@ -0,0 +1,53 @@
|
||||
# file openpyxl/__init__.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Imports for the openpyxl package."""
|
||||
|
||||
# package imports
|
||||
from . import cell
|
||||
from . import namedrange
|
||||
from . import style
|
||||
from . import workbook
|
||||
from . import worksheet
|
||||
from . import reader
|
||||
from . import shared
|
||||
from . import writer
|
||||
|
||||
# constants
|
||||
|
||||
__major__ = 1 # for major interface/format changes
|
||||
__minor__ = 5 # for minor interface/format changes
|
||||
__release__ = 2 # for tweaks, bug-fixes, or development
|
||||
|
||||
__version__ = '%d.%d.%d' % (__major__, __minor__, __release__)
|
||||
|
||||
__author__ = 'Eric Gazoni'
|
||||
__license__ = 'MIT/Expat'
|
||||
__author_email__ = 'eric.gazoni@gmail.com'
|
||||
__maintainer_email__ = 'openpyxl-users@googlegroups.com'
|
||||
__url__ = 'http://bitbucket.org/ericgazoni/openpyxl/wiki/Home'
|
||||
__downloadUrl__ = "http://bitbucket.org/ericgazoni/openpyxl/downloads"
|
||||
|
||||
__all__ = ('reader', 'shared', 'writer',)
|
||||
@@ -0,0 +1,384 @@
|
||||
# file openpyxl/cell.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Manage individual cells in a spreadsheet.
|
||||
|
||||
The Cell class is required to know its value and type, display options,
|
||||
and any other features of an Excel cell. Utilities for referencing
|
||||
cells using Excel's 'A1' column/row nomenclature are also provided.
|
||||
|
||||
"""
|
||||
|
||||
__docformat__ = "restructuredtext en"
|
||||
|
||||
# Python stdlib imports
|
||||
import datetime
|
||||
import re
|
||||
|
||||
# package imports
|
||||
from .shared.date_time import SharedDate
|
||||
from .shared.exc import CellCoordinatesException, \
|
||||
ColumnStringIndexException, DataTypeException
|
||||
from .style import NumberFormat
|
||||
|
||||
# constants
|
||||
COORD_RE = re.compile('^[$]?([A-Z]+)[$]?(\d+)$')
|
||||
|
||||
ABSOLUTE_RE = re.compile('^[$]?([A-Z]+)[$]?(\d+)(:[$]?([A-Z]+)[$]?(\d+))?$')
|
||||
|
||||
def coordinate_from_string(coord_string):
|
||||
"""Convert a coordinate string like 'B12' to a tuple ('B', 12)"""
|
||||
match = COORD_RE.match(coord_string.upper())
|
||||
if not match:
|
||||
msg = 'Invalid cell coordinates (%s)' % coord_string
|
||||
raise CellCoordinatesException(msg)
|
||||
column, row = match.groups()
|
||||
return (column, int(row))
|
||||
|
||||
|
||||
def absolute_coordinate(coord_string):
|
||||
"""Convert a coordinate to an absolute coordinate string (B12 -> $B$12)"""
|
||||
parts = ABSOLUTE_RE.match(coord_string).groups()
|
||||
|
||||
if all(parts[-2:]):
|
||||
return '$%s$%s:$%s$%s' % (parts[0], parts[1], parts[3], parts[4])
|
||||
else:
|
||||
return '$%s$%s' % (parts[0], parts[1])
|
||||
|
||||
|
||||
def column_index_from_string(column, fast = False):
|
||||
"""Convert a column letter into a column number (e.g. B -> 2)
|
||||
|
||||
Excel only supports 1-3 letter column names from A -> ZZZ, so we
|
||||
restrict our column names to 1-3 characters, each in the range A-Z.
|
||||
|
||||
.. note::
|
||||
|
||||
Fast mode is faster but does not check that all letters are capitals between A and Z
|
||||
|
||||
"""
|
||||
column = column.upper()
|
||||
|
||||
clen = len(column)
|
||||
|
||||
if not fast and not all('A' <= char <= 'Z' for char in column):
|
||||
msg = 'Column string must contain only characters A-Z: got %s' % column
|
||||
raise ColumnStringIndexException(msg)
|
||||
|
||||
if clen == 1:
|
||||
return ord(column[0]) - 64
|
||||
elif clen == 2:
|
||||
return ((1 + (ord(column[0]) - 65)) * 26) + (ord(column[1]) - 64)
|
||||
elif clen == 3:
|
||||
return ((1 + (ord(column[0]) - 65)) * 676) + ((1 + (ord(column[1]) - 65)) * 26) + (ord(column[2]) - 64)
|
||||
elif clen > 3:
|
||||
raise ColumnStringIndexException('Column string index can not be longer than 3 characters')
|
||||
else:
|
||||
raise ColumnStringIndexException('Column string index can not be empty')
|
||||
|
||||
|
||||
def get_column_letter(col_idx):
|
||||
"""Convert a column number into a column letter (3 -> 'C')
|
||||
|
||||
Right shift the column col_idx by 26 to find column letters in reverse
|
||||
order. These numbers are 1-based, and can be converted to ASCII
|
||||
ordinals by adding 64.
|
||||
|
||||
"""
|
||||
# these indicies corrospond to A -> ZZZ and include all allowed
|
||||
# columns
|
||||
if not 1 <= col_idx <= 18278:
|
||||
msg = 'Column index out of bounds: %s' % col_idx
|
||||
raise ColumnStringIndexException(msg)
|
||||
ordinals = []
|
||||
temp = col_idx
|
||||
while temp:
|
||||
quotient, remainder = divmod(temp, 26)
|
||||
# check for exact division and borrow if needed
|
||||
if remainder == 0:
|
||||
quotient -= 1
|
||||
remainder = 26
|
||||
ordinals.append(remainder + 64)
|
||||
temp = quotient
|
||||
ordinals.reverse()
|
||||
return ''.join([chr(ordinal) for ordinal in ordinals])
|
||||
|
||||
|
||||
class Cell(object):
|
||||
"""Describes cell associated properties.
|
||||
|
||||
Properties of interest include style, type, value, and address.
|
||||
|
||||
"""
|
||||
__slots__ = ('column',
|
||||
'row',
|
||||
'_value',
|
||||
'_data_type',
|
||||
'parent',
|
||||
'xf_index',
|
||||
'_hyperlink_rel')
|
||||
|
||||
ERROR_CODES = {'#NULL!': 0,
|
||||
'#DIV/0!': 1,
|
||||
'#VALUE!': 2,
|
||||
'#REF!': 3,
|
||||
'#NAME?': 4,
|
||||
'#NUM!': 5,
|
||||
'#N/A': 6}
|
||||
|
||||
TYPE_STRING = 's'
|
||||
TYPE_FORMULA = 'f'
|
||||
TYPE_NUMERIC = 'n'
|
||||
TYPE_BOOL = 'b'
|
||||
TYPE_NULL = 's'
|
||||
TYPE_INLINE = 'inlineStr'
|
||||
TYPE_ERROR = 'e'
|
||||
|
||||
VALID_TYPES = [TYPE_STRING, TYPE_FORMULA, TYPE_NUMERIC, TYPE_BOOL,
|
||||
TYPE_NULL, TYPE_INLINE, TYPE_ERROR]
|
||||
|
||||
RE_PATTERNS = {
|
||||
'percentage': re.compile('^\-?[0-9]*\.?[0-9]*\s?\%$'),
|
||||
'time': re.compile('^(\d|[0-1]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$'),
|
||||
'numeric': re.compile('^\-?([0-9]+\\.?[0-9]*|[0-9]*\\.?[0-9]+)((E|e)\-?[0-9]+)?$'), }
|
||||
|
||||
def __init__(self, worksheet, column, row, value = None):
|
||||
self.column = column.upper()
|
||||
self.row = row
|
||||
# _value is the stored value, while value is the displayed value
|
||||
self._value = None
|
||||
self._hyperlink_rel = None
|
||||
self._data_type = self.TYPE_NULL
|
||||
if value:
|
||||
self.value = value
|
||||
self.parent = worksheet
|
||||
self.xf_index = 0
|
||||
|
||||
def __repr__(self):
|
||||
return "<Cell %s.%s>" % (self.parent.title, self.get_coordinate())
|
||||
|
||||
def check_string(self, value):
|
||||
"""Check string coding, length, and line break character"""
|
||||
# convert to unicode string
|
||||
value = unicode(value)
|
||||
# string must never be longer than 32,767 characters
|
||||
# truncate if necessary
|
||||
value = value[:32767]
|
||||
# we require that newline is represented as "\n" in core,
|
||||
# not as "\r\n" or "\r"
|
||||
value = value.replace('\r\n', '\n')
|
||||
return value
|
||||
|
||||
def check_numeric(self, value):
|
||||
"""Cast value to int or float if necessary"""
|
||||
if not isinstance(value, (int, float)):
|
||||
try:
|
||||
value = int(value)
|
||||
except ValueError:
|
||||
value = float(value)
|
||||
return value
|
||||
|
||||
def set_value_explicit(self, value = None, data_type = TYPE_STRING):
|
||||
"""Coerce values according to their explicit type"""
|
||||
type_coercion_map = {
|
||||
self.TYPE_INLINE: self.check_string,
|
||||
self.TYPE_STRING: self.check_string,
|
||||
self.TYPE_FORMULA: unicode,
|
||||
self.TYPE_NUMERIC: self.check_numeric,
|
||||
self.TYPE_BOOL: bool, }
|
||||
try:
|
||||
self._value = type_coercion_map[data_type](value)
|
||||
except KeyError:
|
||||
if data_type not in self.VALID_TYPES:
|
||||
msg = 'Invalid data type: %s' % data_type
|
||||
raise DataTypeException(msg)
|
||||
self._data_type = data_type
|
||||
|
||||
def data_type_for_value(self, value):
|
||||
"""Given a value, infer the correct data type"""
|
||||
if value is None:
|
||||
data_type = self.TYPE_NULL
|
||||
elif value is True or value is False:
|
||||
data_type = self.TYPE_BOOL
|
||||
elif isinstance(value, (int, float)):
|
||||
data_type = self.TYPE_NUMERIC
|
||||
elif not value:
|
||||
data_type = self.TYPE_STRING
|
||||
elif isinstance(value, (datetime.datetime, datetime.date)):
|
||||
data_type = self.TYPE_NUMERIC
|
||||
elif isinstance(value, basestring) and value[0] == '=':
|
||||
data_type = self.TYPE_FORMULA
|
||||
elif self.RE_PATTERNS['numeric'].match(value):
|
||||
data_type = self.TYPE_NUMERIC
|
||||
elif value.strip() in self.ERROR_CODES:
|
||||
data_type = self.TYPE_ERROR
|
||||
else:
|
||||
data_type = self.TYPE_STRING
|
||||
return data_type
|
||||
|
||||
def bind_value(self, value):
|
||||
"""Given a value, infer type and display options."""
|
||||
self._data_type = self.data_type_for_value(value)
|
||||
if value is None:
|
||||
self.set_value_explicit('', self.TYPE_NULL)
|
||||
return True
|
||||
elif self._data_type == self.TYPE_STRING:
|
||||
# percentage detection
|
||||
percentage_search = self.RE_PATTERNS['percentage'].match(value)
|
||||
if percentage_search and value.strip() != '%':
|
||||
value = float(value.replace('%', '')) / 100.0
|
||||
self.set_value_explicit(value, self.TYPE_NUMERIC)
|
||||
self._set_number_format(NumberFormat.FORMAT_PERCENTAGE)
|
||||
return True
|
||||
# time detection
|
||||
time_search = self.RE_PATTERNS['time'].match(value)
|
||||
if time_search:
|
||||
sep_count = value.count(':') #pylint: disable-msg=E1103
|
||||
if sep_count == 1:
|
||||
hours, minutes = [int(bit) for bit in value.split(':')] #pylint: disable-msg=E1103
|
||||
seconds = 0
|
||||
elif sep_count == 2:
|
||||
hours, minutes, seconds = \
|
||||
[int(bit) for bit in value.split(':')] #pylint: disable-msg=E1103
|
||||
days = (hours / 24.0) + (minutes / 1440.0) + \
|
||||
(seconds / 86400.0)
|
||||
self.set_value_explicit(days, self.TYPE_NUMERIC)
|
||||
self._set_number_format(NumberFormat.FORMAT_DATE_TIME3)
|
||||
return True
|
||||
if self._data_type == self.TYPE_NUMERIC:
|
||||
# date detection
|
||||
# if the value is a date, but not a date time, make it a
|
||||
# datetime, and set the time part to 0
|
||||
if isinstance(value, datetime.date) and not \
|
||||
isinstance(value, datetime.datetime):
|
||||
value = datetime.datetime.combine(value, datetime.time())
|
||||
if isinstance(value, datetime.datetime):
|
||||
value = SharedDate().datetime_to_julian(date = value)
|
||||
self.set_value_explicit(value, self.TYPE_NUMERIC)
|
||||
self._set_number_format(NumberFormat.FORMAT_DATE_YYYYMMDD2)
|
||||
return True
|
||||
self.set_value_explicit(value, self._data_type)
|
||||
|
||||
def _get_value(self):
|
||||
"""Return the value, formatted as a date if needed"""
|
||||
value = self._value
|
||||
if self.is_date():
|
||||
value = SharedDate().from_julian(value)
|
||||
return value
|
||||
|
||||
def _set_value(self, value):
|
||||
"""Set the value and infer type and display options."""
|
||||
self.bind_value(value)
|
||||
|
||||
value = property(_get_value, _set_value,
|
||||
doc = 'Get or set the value held in the cell.\n\n'
|
||||
':rtype: depends on the value (string, float, int or '
|
||||
':class:`datetime.datetime`)')
|
||||
|
||||
def _set_hyperlink(self, val):
|
||||
"""Set value and display for hyperlinks in a cell"""
|
||||
if self._hyperlink_rel is None:
|
||||
self._hyperlink_rel = self.parent.create_relationship("hyperlink")
|
||||
self._hyperlink_rel.target = val
|
||||
self._hyperlink_rel.target_mode = "External"
|
||||
if self._value is None:
|
||||
self.value = val
|
||||
|
||||
def _get_hyperlink(self):
|
||||
"""Return the hyperlink target or an empty string"""
|
||||
return self._hyperlink_rel is not None and \
|
||||
self._hyperlink_rel.target or ''
|
||||
|
||||
hyperlink = property(_get_hyperlink, _set_hyperlink,
|
||||
doc = 'Get or set the hyperlink held in the cell. '
|
||||
'Automatically sets the `value` of the cell with link text, '
|
||||
'but you can modify it afterwards by setting the '
|
||||
'`value` property, and the hyperlink will remain.\n\n'
|
||||
':rtype: string')
|
||||
|
||||
@property
|
||||
def hyperlink_rel_id(self):
|
||||
"""Return the id pointed to by the hyperlink, or None"""
|
||||
return self._hyperlink_rel is not None and \
|
||||
self._hyperlink_rel.id or None
|
||||
|
||||
def _set_number_format(self, format_code):
|
||||
"""Set a new formatting code for numeric values"""
|
||||
self.style.number_format.format_code = format_code
|
||||
|
||||
@property
|
||||
def has_style(self):
|
||||
"""Check if the parent worksheet has a style for this cell"""
|
||||
return self.get_coordinate() in self.parent._styles #pylint: disable-msg=W0212
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""Returns the :class:`openpyxl.style.Style` object for this cell"""
|
||||
return self.parent.get_style(self.get_coordinate())
|
||||
|
||||
@property
|
||||
def data_type(self):
|
||||
"""Return the data type represented by this cell"""
|
||||
return self._data_type
|
||||
|
||||
def get_coordinate(self):
|
||||
"""Return the coordinate string for this cell (e.g. 'B12')
|
||||
|
||||
:rtype: string
|
||||
"""
|
||||
return '%s%s' % (self.column, self.row)
|
||||
|
||||
@property
|
||||
def address(self):
|
||||
"""Return the coordinate string for this cell (e.g. 'B12')
|
||||
|
||||
:rtype: string
|
||||
"""
|
||||
return self.get_coordinate()
|
||||
|
||||
def offset(self, row = 0, column = 0):
|
||||
"""Returns a cell location relative to this cell.
|
||||
|
||||
:param row: number of rows to offset
|
||||
:type row: int
|
||||
|
||||
:param column: number of columns to offset
|
||||
:type column: int
|
||||
|
||||
:rtype: :class:`openpyxl.cell.Cell`
|
||||
"""
|
||||
offset_column = get_column_letter(column_index_from_string(
|
||||
column = self.column) + column)
|
||||
offset_row = self.row + row
|
||||
return self.parent.cell('%s%s' % (offset_column, offset_row))
|
||||
|
||||
def is_date(self):
|
||||
"""Returns whether the value is *probably* a date or not
|
||||
|
||||
:rtype: bool
|
||||
"""
|
||||
return (self.has_style
|
||||
and self.style.number_format.is_date_format()
|
||||
and isinstance(self._value, (int, float)))
|
||||
@@ -0,0 +1,340 @@
|
||||
'''
|
||||
Copyright (c) 2010 openpyxl
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@license: http://www.opensource.org/licenses/mit-license.php
|
||||
@author: Eric Gazoni
|
||||
'''
|
||||
|
||||
import math
|
||||
|
||||
from .style import NumberFormat
|
||||
from .drawing import Drawing, Shape
|
||||
from .shared.units import pixels_to_EMU, short_color
|
||||
from .cell import get_column_letter
|
||||
|
||||
class Axis(object):
|
||||
|
||||
POSITION_BOTTOM = 'b'
|
||||
POSITION_LEFT = 'l'
|
||||
|
||||
ORIENTATION_MIN_MAX = "minMax"
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.orientation = self.ORIENTATION_MIN_MAX
|
||||
self.number_format = NumberFormat()
|
||||
for attr in ('position','tick_label_position','crosses',
|
||||
'auto','label_align','label_offset','cross_between'):
|
||||
setattr(self, attr, None)
|
||||
self.min = 0
|
||||
self.max = None
|
||||
self.unit = None
|
||||
|
||||
@classmethod
|
||||
def default_category(cls):
|
||||
""" default values for category axes """
|
||||
|
||||
ax = Axis()
|
||||
ax.id = 60871424
|
||||
ax.cross = 60873344
|
||||
ax.position = Axis.POSITION_BOTTOM
|
||||
ax.tick_label_position = 'nextTo'
|
||||
ax.crosses = "autoZero"
|
||||
ax.auto = True
|
||||
ax.label_align = 'ctr'
|
||||
ax.label_offset = 100
|
||||
return ax
|
||||
|
||||
@classmethod
|
||||
def default_value(cls):
|
||||
""" default values for value axes """
|
||||
|
||||
ax = Axis()
|
||||
ax.id = 60873344
|
||||
ax.cross = 60871424
|
||||
ax.position = Axis.POSITION_LEFT
|
||||
ax.major_gridlines = None
|
||||
ax.tick_label_position = 'nextTo'
|
||||
ax.crosses = 'autoZero'
|
||||
ax.auto = False
|
||||
ax.cross_between = 'between'
|
||||
return ax
|
||||
|
||||
class Reference(object):
|
||||
""" a simple wrapper around a serie of reference data """
|
||||
|
||||
def __init__(self, sheet, pos1, pos2=None):
|
||||
|
||||
self.sheet = sheet
|
||||
self.pos1 = pos1
|
||||
self.pos2 = pos2
|
||||
|
||||
def get_type(self):
|
||||
|
||||
if isinstance(self.cache[0], basestring):
|
||||
return 'str'
|
||||
else:
|
||||
return 'num'
|
||||
|
||||
def _get_ref(self):
|
||||
""" format excel reference notation """
|
||||
|
||||
if self.pos2:
|
||||
return '%s!$%s$%s:$%s$%s' % (self.sheet.title,
|
||||
get_column_letter(self.pos1[1]+1), self.pos1[0]+1,
|
||||
get_column_letter(self.pos2[1]+1), self.pos2[0]+1)
|
||||
else:
|
||||
return '%s!$%s$%s' % (self.sheet.title,
|
||||
get_column_letter(self.pos1[1]+1), self.pos1[0]+1)
|
||||
|
||||
|
||||
def _get_cache(self):
|
||||
""" read data in sheet - to be used at writing time """
|
||||
|
||||
cache = []
|
||||
if self.pos2:
|
||||
for row in range(self.pos1[0], self.pos2[0]+1):
|
||||
for col in range(self.pos1[1], self.pos2[1]+1):
|
||||
cache.append(self.sheet.cell(row=row, column=col).value)
|
||||
else:
|
||||
cell = self.sheet.cell(row=self.pos1[0], column=self.pos1[1])
|
||||
cache.append(cell.value)
|
||||
return cache
|
||||
|
||||
|
||||
class Serie(object):
|
||||
""" a serie of data and possibly associated labels """
|
||||
|
||||
MARKER_NONE = 'none'
|
||||
|
||||
def __init__(self, values, labels=None, legend=None, color=None, xvalues=None):
|
||||
|
||||
self.marker = Serie.MARKER_NONE
|
||||
self.values = values
|
||||
self.xvalues = xvalues
|
||||
self.labels = labels
|
||||
self.legend = legend
|
||||
self.error_bar = None
|
||||
self._color = color
|
||||
|
||||
def _get_color(self):
|
||||
return self._color
|
||||
|
||||
def _set_color(self, color):
|
||||
self._color = short_color(color)
|
||||
|
||||
color = property(_get_color, _set_color)
|
||||
|
||||
def get_min_max(self):
|
||||
|
||||
if self.error_bar:
|
||||
err_cache = self.error_bar.values._get_cache()
|
||||
vals = [v + err_cache[i] \
|
||||
for i,v in enumerate(self.values._get_cache())]
|
||||
else:
|
||||
vals = self.values._get_cache()
|
||||
return min(vals), max(vals)
|
||||
|
||||
def __len__(self):
|
||||
|
||||
return len(self.values.cache)
|
||||
|
||||
class Legend(object):
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.position = 'r'
|
||||
self.layout = None
|
||||
|
||||
class ErrorBar(object):
|
||||
|
||||
PLUS = 1
|
||||
MINUS = 2
|
||||
PLUS_MINUS = 3
|
||||
|
||||
def __init__(self, _type, values):
|
||||
|
||||
self.type = _type
|
||||
self.values = values
|
||||
|
||||
class Chart(object):
|
||||
""" raw chart class """
|
||||
|
||||
GROUPING_CLUSTERED = 'clustered'
|
||||
GROUPING_STANDARD = 'standard'
|
||||
|
||||
BAR_CHART = 1
|
||||
LINE_CHART = 2
|
||||
SCATTER_CHART = 3
|
||||
|
||||
def __init__(self, _type, grouping):
|
||||
|
||||
self._series = []
|
||||
|
||||
# public api
|
||||
self.type = _type
|
||||
self.grouping = grouping
|
||||
self.x_axis = Axis.default_category()
|
||||
self.y_axis = Axis.default_value()
|
||||
self.legend = Legend()
|
||||
self.lang = 'fr-FR'
|
||||
self.title = ''
|
||||
self.print_margins = dict(b=.75, l=.7, r=.7, t=.75, header=0.3, footer=.3)
|
||||
|
||||
# the containing drawing
|
||||
self.drawing = Drawing()
|
||||
|
||||
# the offset for the plot part in percentage of the drawing size
|
||||
self.width = .6
|
||||
self.height = .6
|
||||
self.margin_top = self._get_max_margin_top()
|
||||
self.margin_left = 0
|
||||
|
||||
# the user defined shapes
|
||||
self._shapes = []
|
||||
|
||||
def add_serie(self, serie):
|
||||
|
||||
serie.id = len(self._series)
|
||||
self._series.append(serie)
|
||||
self._compute_min_max()
|
||||
if not None in [s.xvalues for s in self._series]:
|
||||
self._compute_xmin_xmax()
|
||||
|
||||
def add_shape(self, shape):
|
||||
|
||||
shape._chart = self
|
||||
self._shapes.append(shape)
|
||||
|
||||
def get_x_units(self):
|
||||
""" calculate one unit for x axis in EMU """
|
||||
|
||||
return max([len(s.values._get_cache()) for s in self._series])
|
||||
|
||||
def get_y_units(self):
|
||||
""" calculate one unit for y axis in EMU """
|
||||
|
||||
dh = pixels_to_EMU(self.drawing.height)
|
||||
return (dh * self.height) / self.y_axis.max
|
||||
|
||||
def get_y_chars(self):
|
||||
""" estimate nb of chars for y axis """
|
||||
|
||||
_max = max([max(s.values._get_cache()) for s in self._series])
|
||||
return len(str(int(_max)))
|
||||
|
||||
def _compute_min_max(self):
|
||||
""" compute y axis limits and units """
|
||||
|
||||
maxi = max([max(s.values._get_cache()) for s in self._series])
|
||||
|
||||
mul = None
|
||||
if maxi < 1:
|
||||
s = str(maxi).split('.')[1]
|
||||
mul = 10
|
||||
for x in s:
|
||||
if x == '0':
|
||||
mul *= 10
|
||||
else:
|
||||
break
|
||||
maxi = maxi * mul
|
||||
|
||||
maxi = math.ceil(maxi * 1.1)
|
||||
sz = len(str(int(maxi))) - 1
|
||||
unit = math.ceil(math.ceil(maxi / pow(10, sz)) * pow(10, sz-1))
|
||||
maxi = math.ceil(maxi/unit) * unit
|
||||
|
||||
if mul is not None:
|
||||
maxi = maxi/mul
|
||||
unit = unit/mul
|
||||
|
||||
if maxi / unit > 9:
|
||||
# no more that 10 ticks
|
||||
unit *= 2
|
||||
|
||||
self.y_axis.max = maxi
|
||||
self.y_axis.unit = unit
|
||||
|
||||
def _compute_xmin_xmax(self):
|
||||
""" compute x axis limits and units """
|
||||
|
||||
maxi = max([max(s.xvalues._get_cache()) for s in self._series])
|
||||
|
||||
mul = None
|
||||
if maxi < 1:
|
||||
s = str(maxi).split('.')[1]
|
||||
mul = 10
|
||||
for x in s:
|
||||
if x == '0':
|
||||
mul *= 10
|
||||
else:
|
||||
break
|
||||
maxi = maxi * mul
|
||||
|
||||
maxi = math.ceil(maxi * 1.1)
|
||||
sz = len(str(int(maxi))) - 1
|
||||
unit = math.ceil(math.ceil(maxi / pow(10, sz)) * pow(10, sz-1))
|
||||
maxi = math.ceil(maxi/unit) * unit
|
||||
|
||||
if mul is not None:
|
||||
maxi = maxi/mul
|
||||
unit = unit/mul
|
||||
|
||||
if maxi / unit > 9:
|
||||
# no more that 10 ticks
|
||||
unit *= 2
|
||||
|
||||
self.x_axis.max = maxi
|
||||
self.x_axis.unit = unit
|
||||
|
||||
def _get_max_margin_top(self):
|
||||
|
||||
mb = Shape.FONT_HEIGHT + Shape.MARGIN_BOTTOM
|
||||
plot_height = self.drawing.height * self.height
|
||||
return float(self.drawing.height - plot_height - mb)/self.drawing.height
|
||||
|
||||
def _get_min_margin_left(self):
|
||||
|
||||
ml = (self.get_y_chars() * Shape.FONT_WIDTH) + Shape.MARGIN_LEFT
|
||||
return float(ml)/self.drawing.width
|
||||
|
||||
def _get_margin_top(self):
|
||||
""" get margin in percent """
|
||||
|
||||
return min(self.margin_top, self._get_max_margin_top())
|
||||
|
||||
def _get_margin_left(self):
|
||||
|
||||
return max(self._get_min_margin_left(), self.margin_left)
|
||||
|
||||
class BarChart(Chart):
|
||||
def __init__(self):
|
||||
super(BarChart, self).__init__(Chart.BAR_CHART, Chart.GROUPING_CLUSTERED)
|
||||
|
||||
class LineChart(Chart):
|
||||
def __init__(self):
|
||||
super(LineChart, self).__init__(Chart.LINE_CHART, Chart.GROUPING_STANDARD)
|
||||
|
||||
class ScatterChart(Chart):
|
||||
def __init__(self):
|
||||
super(ScatterChart, self).__init__(Chart.SCATTER_CHART, Chart.GROUPING_STANDARD)
|
||||
|
||||
|
||||
@@ -0,0 +1,401 @@
|
||||
'''
|
||||
Copyright (c) 2010 openpyxl
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@license: http://www.opensource.org/licenses/mit-license.php
|
||||
@author: Eric Gazoni
|
||||
'''
|
||||
|
||||
import math
|
||||
from .style import Color
|
||||
from .shared.units import pixels_to_EMU, EMU_to_pixels, short_color
|
||||
|
||||
class Shadow(object):
|
||||
|
||||
SHADOW_BOTTOM = 'b'
|
||||
SHADOW_BOTTOM_LEFT = 'bl'
|
||||
SHADOW_BOTTOM_RIGHT = 'br'
|
||||
SHADOW_CENTER = 'ctr'
|
||||
SHADOW_LEFT = 'l'
|
||||
SHADOW_TOP = 't'
|
||||
SHADOW_TOP_LEFT = 'tl'
|
||||
SHADOW_TOP_RIGHT = 'tr'
|
||||
|
||||
def __init__(self):
|
||||
self.visible = False
|
||||
self.blurRadius = 6
|
||||
self.distance = 2
|
||||
self.direction = 0
|
||||
self.alignment = self.SHADOW_BOTTOM_RIGHT
|
||||
self.color = Color(Color.BLACK)
|
||||
self.alpha = 50
|
||||
|
||||
class Drawing(object):
|
||||
""" a drawing object - eg container for shapes or charts
|
||||
we assume user specifies dimensions in pixels; units are
|
||||
converted to EMU in the drawing part
|
||||
"""
|
||||
|
||||
count = 0
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.name = ''
|
||||
self.description = ''
|
||||
self.coordinates = ((1,2), (16,8))
|
||||
self.left = 0
|
||||
self.top = 0
|
||||
self._width = EMU_to_pixels(200000)
|
||||
self._height = EMU_to_pixels(1828800)
|
||||
self.resize_proportional = False
|
||||
self.rotation = 0
|
||||
# self.shadow = Shadow()
|
||||
|
||||
def _set_width(self, w):
|
||||
|
||||
if self.resize_proportional and w:
|
||||
ratio = self._height / self._width
|
||||
self._height = round(ratio * w)
|
||||
self._width = w
|
||||
|
||||
def _get_width(self):
|
||||
|
||||
return self._width
|
||||
|
||||
width = property(_get_width, _set_width)
|
||||
|
||||
def _set_height(self, h):
|
||||
|
||||
if self.resize_proportional and h:
|
||||
ratio = self._width / self._height
|
||||
self._width = round(ratio * h)
|
||||
self._height = h
|
||||
|
||||
def _get_height(self):
|
||||
|
||||
return self._height
|
||||
|
||||
height = property(_get_height, _set_height)
|
||||
|
||||
def set_dimension(self, w=0, h=0):
|
||||
|
||||
xratio = w / self._width
|
||||
yratio = h / self._height
|
||||
|
||||
if self.resize_proportional and w and h:
|
||||
if (xratio * self._height) < h:
|
||||
self._height = math.ceil(xratio * self._height)
|
||||
self._width = width
|
||||
else:
|
||||
self._width = math.ceil(yratio * self._width)
|
||||
self._height = height
|
||||
|
||||
def get_emu_dimensions(self):
|
||||
""" return (x, y, w, h) in EMU """
|
||||
|
||||
return (pixels_to_EMU(self.left), pixels_to_EMU(self.top),
|
||||
pixels_to_EMU(self._width), pixels_to_EMU(self._height))
|
||||
|
||||
|
||||
class Shape(object):
|
||||
""" a drawing inside a chart
|
||||
coordiantes are specified by the user in the axis units
|
||||
"""
|
||||
|
||||
MARGIN_LEFT = 6 + 13 + 1
|
||||
MARGIN_BOTTOM = 17 + 11
|
||||
|
||||
FONT_WIDTH = 7
|
||||
FONT_HEIGHT = 8
|
||||
|
||||
ROUND_RECT = 'roundRect'
|
||||
RECT = 'rect'
|
||||
|
||||
# other shapes to define :
|
||||
'''
|
||||
"line"
|
||||
"lineInv"
|
||||
"triangle"
|
||||
"rtTriangle"
|
||||
"diamond"
|
||||
"parallelogram"
|
||||
"trapezoid"
|
||||
"nonIsoscelesTrapezoid"
|
||||
"pentagon"
|
||||
"hexagon"
|
||||
"heptagon"
|
||||
"octagon"
|
||||
"decagon"
|
||||
"dodecagon"
|
||||
"star4"
|
||||
"star5"
|
||||
"star6"
|
||||
"star7"
|
||||
"star8"
|
||||
"star10"
|
||||
"star12"
|
||||
"star16"
|
||||
"star24"
|
||||
"star32"
|
||||
"roundRect"
|
||||
"round1Rect"
|
||||
"round2SameRect"
|
||||
"round2DiagRect"
|
||||
"snipRoundRect"
|
||||
"snip1Rect"
|
||||
"snip2SameRect"
|
||||
"snip2DiagRect"
|
||||
"plaque"
|
||||
"ellipse"
|
||||
"teardrop"
|
||||
"homePlate"
|
||||
"chevron"
|
||||
"pieWedge"
|
||||
"pie"
|
||||
"blockArc"
|
||||
"donut"
|
||||
"noSmoking"
|
||||
"rightArrow"
|
||||
"leftArrow"
|
||||
"upArrow"
|
||||
"downArrow"
|
||||
"stripedRightArrow"
|
||||
"notchedRightArrow"
|
||||
"bentUpArrow"
|
||||
"leftRightArrow"
|
||||
"upDownArrow"
|
||||
"leftUpArrow"
|
||||
"leftRightUpArrow"
|
||||
"quadArrow"
|
||||
"leftArrowCallout"
|
||||
"rightArrowCallout"
|
||||
"upArrowCallout"
|
||||
"downArrowCallout"
|
||||
"leftRightArrowCallout"
|
||||
"upDownArrowCallout"
|
||||
"quadArrowCallout"
|
||||
"bentArrow"
|
||||
"uturnArrow"
|
||||
"circularArrow"
|
||||
"leftCircularArrow"
|
||||
"leftRightCircularArrow"
|
||||
"curvedRightArrow"
|
||||
"curvedLeftArrow"
|
||||
"curvedUpArrow"
|
||||
"curvedDownArrow"
|
||||
"swooshArrow"
|
||||
"cube"
|
||||
"can"
|
||||
"lightningBolt"
|
||||
"heart"
|
||||
"sun"
|
||||
"moon"
|
||||
"smileyFace"
|
||||
"irregularSeal1"
|
||||
"irregularSeal2"
|
||||
"foldedCorner"
|
||||
"bevel"
|
||||
"frame"
|
||||
"halfFrame"
|
||||
"corner"
|
||||
"diagStripe"
|
||||
"chord"
|
||||
"arc"
|
||||
"leftBracket"
|
||||
"rightBracket"
|
||||
"leftBrace"
|
||||
"rightBrace"
|
||||
"bracketPair"
|
||||
"bracePair"
|
||||
"straightConnector1"
|
||||
"bentConnector2"
|
||||
"bentConnector3"
|
||||
"bentConnector4"
|
||||
"bentConnector5"
|
||||
"curvedConnector2"
|
||||
"curvedConnector3"
|
||||
"curvedConnector4"
|
||||
"curvedConnector5"
|
||||
"callout1"
|
||||
"callout2"
|
||||
"callout3"
|
||||
"accentCallout1"
|
||||
"accentCallout2"
|
||||
"accentCallout3"
|
||||
"borderCallout1"
|
||||
"borderCallout2"
|
||||
"borderCallout3"
|
||||
"accentBorderCallout1"
|
||||
"accentBorderCallout2"
|
||||
"accentBorderCallout3"
|
||||
"wedgeRectCallout"
|
||||
"wedgeRoundRectCallout"
|
||||
"wedgeEllipseCallout"
|
||||
"cloudCallout"
|
||||
"cloud"
|
||||
"ribbon"
|
||||
"ribbon2"
|
||||
"ellipseRibbon"
|
||||
"ellipseRibbon2"
|
||||
"leftRightRibbon"
|
||||
"verticalScroll"
|
||||
"horizontalScroll"
|
||||
"wave"
|
||||
"doubleWave"
|
||||
"plus"
|
||||
"flowChartProcess"
|
||||
"flowChartDecision"
|
||||
"flowChartInputOutput"
|
||||
"flowChartPredefinedProcess"
|
||||
"flowChartInternalStorage"
|
||||
"flowChartDocument"
|
||||
"flowChartMultidocument"
|
||||
"flowChartTerminator"
|
||||
"flowChartPreparation"
|
||||
"flowChartManualInput"
|
||||
"flowChartManualOperation"
|
||||
"flowChartConnector"
|
||||
"flowChartPunchedCard"
|
||||
"flowChartPunchedTape"
|
||||
"flowChartSummingJunction"
|
||||
"flowChartOr"
|
||||
"flowChartCollate"
|
||||
"flowChartSort"
|
||||
"flowChartExtract"
|
||||
"flowChartMerge"
|
||||
"flowChartOfflineStorage"
|
||||
"flowChartOnlineStorage"
|
||||
"flowChartMagneticTape"
|
||||
"flowChartMagneticDisk"
|
||||
"flowChartMagneticDrum"
|
||||
"flowChartDisplay"
|
||||
"flowChartDelay"
|
||||
"flowChartAlternateProcess"
|
||||
"flowChartOffpageConnector"
|
||||
"actionButtonBlank"
|
||||
"actionButtonHome"
|
||||
"actionButtonHelp"
|
||||
"actionButtonInformation"
|
||||
"actionButtonForwardNext"
|
||||
"actionButtonBackPrevious"
|
||||
"actionButtonEnd"
|
||||
"actionButtonBeginning"
|
||||
"actionButtonReturn"
|
||||
"actionButtonDocument"
|
||||
"actionButtonSound"
|
||||
"actionButtonMovie"
|
||||
"gear6"
|
||||
"gear9"
|
||||
"funnel"
|
||||
"mathPlus"
|
||||
"mathMinus"
|
||||
"mathMultiply"
|
||||
"mathDivide"
|
||||
"mathEqual"
|
||||
"mathNotEqual"
|
||||
"cornerTabs"
|
||||
"squareTabs"
|
||||
"plaqueTabs"
|
||||
"chartX"
|
||||
"chartStar"
|
||||
"chartPlus"
|
||||
'''
|
||||
|
||||
def __init__(self, coordinates=((0,0), (1,1)), text=None, scheme="accent1"):
|
||||
|
||||
self.coordinates = coordinates # in axis unit
|
||||
self.text = text
|
||||
self.scheme = scheme
|
||||
self.style = Shape.RECT
|
||||
self._border_width = 3175 # in EMU
|
||||
self._border_color = Color.BLACK[2:] #"F3B3C5"
|
||||
self._color = Color.WHITE[2:]
|
||||
self._text_color = Color.BLACK[2:]
|
||||
|
||||
def _get_border_color(self):
|
||||
return self._border_color
|
||||
|
||||
def _set_border_color(self, color):
|
||||
self._border_color = short_color(color)
|
||||
|
||||
border_color = property(_get_border_color, _set_border_color)
|
||||
|
||||
def _get_color(self):
|
||||
return self._color
|
||||
|
||||
def _set_color(self, color):
|
||||
self._color = short_color(color)
|
||||
|
||||
color = property(_get_color, _set_color)
|
||||
|
||||
def _get_text_color(self):
|
||||
return self._text_color
|
||||
|
||||
def _set_text_color(self, color):
|
||||
self._text_color = short_color(color)
|
||||
|
||||
text_color = property(_get_text_color, _set_text_color)
|
||||
|
||||
def _get_border_width(self):
|
||||
|
||||
return EMU_to_pixels(self._border_width)
|
||||
|
||||
def _set_border_width(self, w):
|
||||
|
||||
self._border_width = pixels_to_EMU(w)
|
||||
# print self._border_width
|
||||
|
||||
border_width = property(_get_border_width, _set_border_width)
|
||||
|
||||
def get_coordinates(self):
|
||||
""" return shape coordinates in percentages (left, top, right, bottom) """
|
||||
|
||||
(x1, y1), (x2, y2) = self.coordinates
|
||||
|
||||
drawing_width = pixels_to_EMU(self._chart.drawing.width)
|
||||
drawing_height = pixels_to_EMU(self._chart.drawing.height)
|
||||
plot_width = drawing_width * self._chart.width
|
||||
plot_height = drawing_height * self._chart.height
|
||||
|
||||
margin_left = self._chart._get_margin_left() * drawing_width
|
||||
xunit = plot_width / self._chart.get_x_units()
|
||||
|
||||
margin_top = self._chart._get_margin_top() * drawing_height
|
||||
yunit = self._chart.get_y_units()
|
||||
|
||||
x_start = (margin_left + (float(x1) * xunit)) / drawing_width
|
||||
y_start = (margin_top + plot_height - (float(y1) * yunit)) / drawing_height
|
||||
|
||||
x_end = (margin_left + (float(x2) * xunit)) / drawing_width
|
||||
y_end = (margin_top + plot_height - (float(y2) * yunit)) / drawing_height
|
||||
|
||||
def _norm_pct(pct):
|
||||
""" force shapes to appear by truncating too large sizes """
|
||||
if pct>1: pct = 1
|
||||
elif pct<0: pct = 0
|
||||
return pct
|
||||
|
||||
# allow user to specify y's in whatever order
|
||||
# excel expect y_end to be lower
|
||||
if y_end < y_start:
|
||||
y_end, y_start = y_start, y_end
|
||||
|
||||
return (_norm_pct(x_start), _norm_pct(y_start),
|
||||
_norm_pct(x_end), _norm_pct(y_end))
|
||||
@@ -0,0 +1,68 @@
|
||||
# file openpyxl/namedrange.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Track named groups of cells in a worksheet"""
|
||||
|
||||
# Python stdlib imports
|
||||
import re
|
||||
|
||||
# package imports
|
||||
from .shared.exc import NamedRangeException
|
||||
|
||||
# constants
|
||||
NAMED_RANGE_RE = re.compile("'?([^']*)'?!((\$([A-Za-z]+))?\$([0-9]+)(:(\$([A-Za-z]+))?(\$([0-9]+)))?)$")
|
||||
|
||||
class NamedRange(object):
|
||||
"""A named group of cells"""
|
||||
__slots__ = ('name', 'destinations', 'local_only')
|
||||
|
||||
def __init__(self, name, destinations):
|
||||
self.name = name
|
||||
self.destinations = destinations
|
||||
self.local_only = False
|
||||
|
||||
def __str__(self):
|
||||
return ','.join(['%s!%s' % (sheet, name) for sheet, name in self.destinations])
|
||||
|
||||
def __repr__(self):
|
||||
|
||||
return '<%s "%s">' % (self.__class__.__name__, str(self))
|
||||
|
||||
|
||||
def split_named_range(range_string):
|
||||
"""Separate a named range into its component parts"""
|
||||
|
||||
destinations = []
|
||||
|
||||
for range_string in range_string.split(','):
|
||||
|
||||
match = NAMED_RANGE_RE.match(range_string)
|
||||
if not match:
|
||||
raise NamedRangeException('Invalid named range string: "%s"' % range_string)
|
||||
else:
|
||||
sheet_name, xlrange = match.groups()[:2]
|
||||
destinations.append((sheet_name, xlrange))
|
||||
|
||||
return destinations
|
||||
@@ -0,0 +1,33 @@
|
||||
# file openpyxl/reader/__init__.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Imports for the openpyxl.reader namespace."""
|
||||
|
||||
# package imports
|
||||
from ..reader import excel
|
||||
from ..reader import strings
|
||||
from ..reader import style
|
||||
from ..reader import workbook
|
||||
from ..reader import worksheet
|
||||
@@ -0,0 +1,109 @@
|
||||
# file openpyxl/reader/excel.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read an xlsx file into Python"""
|
||||
|
||||
# Python stdlib imports
|
||||
from zipfile import ZipFile, ZIP_DEFLATED, BadZipfile
|
||||
|
||||
# package imports
|
||||
from ..shared.exc import OpenModeError, InvalidFileException
|
||||
from ..shared.ooxml import ARC_SHARED_STRINGS, ARC_CORE, ARC_APP, \
|
||||
ARC_WORKBOOK, PACKAGE_WORKSHEETS, ARC_STYLE
|
||||
from ..workbook import Workbook
|
||||
from ..reader.strings import read_string_table
|
||||
from ..reader.style import read_style_table
|
||||
from ..reader.workbook import read_sheets_titles, read_named_ranges, \
|
||||
read_properties_core, get_sheet_ids
|
||||
from ..reader.worksheet import read_worksheet
|
||||
from ..reader.iter_worksheet import unpack_worksheet
|
||||
|
||||
def load_workbook(filename, use_iterators = False):
|
||||
"""Open the given filename and return the workbook
|
||||
|
||||
:param filename: the path to open
|
||||
:type filename: string
|
||||
|
||||
:param use_iterators: use lazy load for cells
|
||||
:type use_iterators: bool
|
||||
|
||||
:rtype: :class:`openpyxl.workbook.Workbook`
|
||||
|
||||
.. note::
|
||||
|
||||
When using lazy load, all worksheets will be :class:`openpyxl.reader.iter_worksheet.IterableWorksheet`
|
||||
and the returned workbook will be read-only.
|
||||
|
||||
"""
|
||||
|
||||
if isinstance(filename, file):
|
||||
# fileobject must have been opened with 'rb' flag
|
||||
# it is required by zipfile
|
||||
if 'b' not in filename.mode:
|
||||
raise OpenModeError("File-object must be opened in binary mode")
|
||||
|
||||
try:
|
||||
archive = ZipFile(filename, 'r', ZIP_DEFLATED)
|
||||
except (BadZipfile, RuntimeError, IOError, ValueError):
|
||||
raise InvalidFileException()
|
||||
wb = Workbook()
|
||||
|
||||
if use_iterators:
|
||||
wb._set_optimized_read()
|
||||
|
||||
try:
|
||||
_load_workbook(wb, archive, filename, use_iterators)
|
||||
except KeyError:
|
||||
raise InvalidFileException()
|
||||
finally:
|
||||
archive.close()
|
||||
return wb
|
||||
|
||||
def _load_workbook(wb, archive, filename, use_iterators):
|
||||
|
||||
# get workbook-level information
|
||||
wb.properties = read_properties_core(archive.read(ARC_CORE))
|
||||
try:
|
||||
string_table = read_string_table(archive.read(ARC_SHARED_STRINGS))
|
||||
except KeyError:
|
||||
string_table = {}
|
||||
style_table = read_style_table(archive.read(ARC_STYLE))
|
||||
|
||||
# get worksheets
|
||||
wb.worksheets = [] # remove preset worksheet
|
||||
sheet_names = read_sheets_titles(archive.read(ARC_APP))
|
||||
for i, sheet_name in enumerate(sheet_names):
|
||||
sheet_codename = 'sheet%d.xml' % (i + 1)
|
||||
worksheet_path = '%s/%s' % (PACKAGE_WORKSHEETS, sheet_codename)
|
||||
|
||||
if not use_iterators:
|
||||
new_ws = read_worksheet(archive.read(worksheet_path), wb, sheet_name, string_table, style_table)
|
||||
else:
|
||||
xml_source = unpack_worksheet(archive, worksheet_path)
|
||||
new_ws = read_worksheet(xml_source, wb, sheet_name, string_table, style_table, filename, sheet_codename)
|
||||
#new_ws = read_worksheet(archive.read(worksheet_path), wb, sheet_name, string_table, style_table, filename, sheet_codename)
|
||||
wb.add_sheet(new_ws, index = i)
|
||||
|
||||
wb._named_ranges = read_named_ranges(archive.read(ARC_WORKBOOK), wb)
|
||||
@@ -0,0 +1,348 @@
|
||||
# file openpyxl/reader/iter_worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
""" Iterators-based worksheet reader
|
||||
*Still very raw*
|
||||
"""
|
||||
|
||||
from ....compat import BytesIO as StringIO
|
||||
import warnings
|
||||
import operator
|
||||
from functools import partial
|
||||
from itertools import groupby, ifilter
|
||||
from ..worksheet import Worksheet
|
||||
from ..cell import coordinate_from_string, get_column_letter, Cell
|
||||
from ..reader.excel import get_sheet_ids
|
||||
from ..reader.strings import read_string_table
|
||||
from ..reader.style import read_style_table, NumberFormat
|
||||
from ..shared.date_time import SharedDate
|
||||
from ..reader.worksheet import read_dimension
|
||||
from ..shared.ooxml import (MIN_COLUMN, MAX_COLUMN, PACKAGE_WORKSHEETS,
|
||||
MAX_ROW, MIN_ROW, ARC_SHARED_STRINGS, ARC_APP, ARC_STYLE)
|
||||
try:
|
||||
from xml.etree.cElementTree import iterparse
|
||||
except ImportError:
|
||||
from xml.etree.ElementTree import iterparse
|
||||
|
||||
|
||||
from zipfile import ZipFile
|
||||
from .. import cell
|
||||
import re
|
||||
import tempfile
|
||||
import zlib
|
||||
import zipfile
|
||||
import struct
|
||||
|
||||
TYPE_NULL = Cell.TYPE_NULL
|
||||
MISSING_VALUE = None
|
||||
|
||||
RE_COORDINATE = re.compile('^([A-Z]+)([0-9]+)$')
|
||||
|
||||
SHARED_DATE = SharedDate()
|
||||
|
||||
_COL_CONVERSION_CACHE = dict((get_column_letter(i), i) for i in xrange(1, 18279))
|
||||
def column_index_from_string(str_col, _col_conversion_cache=_COL_CONVERSION_CACHE):
|
||||
# we use a function argument to get indexed name lookup
|
||||
return _col_conversion_cache[str_col]
|
||||
del _COL_CONVERSION_CACHE
|
||||
|
||||
RAW_ATTRIBUTES = ['row', 'column', 'coordinate', 'internal_value', 'data_type', 'style_id', 'number_format']
|
||||
|
||||
try:
|
||||
from collections import namedtuple
|
||||
BaseRawCell = namedtuple('RawCell', RAW_ATTRIBUTES)
|
||||
except ImportError:
|
||||
|
||||
# warnings.warn("""Unable to import 'namedtuple' module, this may cause memory issues when using optimized reader. Please upgrade your Python installation to 2.6+""")
|
||||
|
||||
class BaseRawCell(object):
|
||||
|
||||
def __init__(self, *args):
|
||||
assert len(args)==len(RAW_ATTRIBUTES)
|
||||
|
||||
for attr, val in zip(RAW_ATTRIBUTES, args):
|
||||
setattr(self, attr, val)
|
||||
|
||||
def _replace(self, **kwargs):
|
||||
|
||||
self.__dict__.update(kwargs)
|
||||
|
||||
return self
|
||||
|
||||
|
||||
class RawCell(BaseRawCell):
|
||||
"""Optimized version of the :class:`openpyxl.cell.Cell`, using named tuples.
|
||||
|
||||
Useful attributes are:
|
||||
|
||||
* row
|
||||
* column
|
||||
* coordinate
|
||||
* internal_value
|
||||
|
||||
You can also access if needed:
|
||||
|
||||
* data_type
|
||||
* number_format
|
||||
|
||||
"""
|
||||
|
||||
@property
|
||||
def is_date(self):
|
||||
res = (self.data_type == Cell.TYPE_NUMERIC
|
||||
and self.number_format is not None
|
||||
and ('d' in self.number_format
|
||||
or 'm' in self.number_format
|
||||
or 'y' in self.number_format
|
||||
or 'h' in self.number_format
|
||||
or 's' in self.number_format
|
||||
))
|
||||
|
||||
return res
|
||||
|
||||
def iter_rows(workbook_name, sheet_name, xml_source, range_string = '', row_offset = 0, column_offset = 0):
|
||||
|
||||
archive = get_archive_file(workbook_name)
|
||||
|
||||
source = xml_source
|
||||
|
||||
if range_string:
|
||||
min_col, min_row, max_col, max_row = get_range_boundaries(range_string, row_offset, column_offset)
|
||||
else:
|
||||
min_col, min_row, max_col, max_row = read_dimension(xml_source = source)
|
||||
min_col = column_index_from_string(min_col)
|
||||
max_col = column_index_from_string(max_col) + 1
|
||||
max_row += 6
|
||||
|
||||
try:
|
||||
string_table = read_string_table(archive.read(ARC_SHARED_STRINGS))
|
||||
except KeyError:
|
||||
string_table = {}
|
||||
|
||||
style_table = read_style_table(archive.read(ARC_STYLE))
|
||||
|
||||
source.seek(0)
|
||||
p = iterparse(source)
|
||||
|
||||
return get_squared_range(p, min_col, min_row, max_col, max_row, string_table, style_table)
|
||||
|
||||
|
||||
def get_rows(p, min_column = MIN_COLUMN, min_row = MIN_ROW, max_column = MAX_COLUMN, max_row = MAX_ROW):
|
||||
|
||||
return groupby(get_cells(p, min_row, min_column, max_row, max_column), operator.attrgetter('row'))
|
||||
|
||||
def get_cells(p, min_row, min_col, max_row, max_col, _re_coordinate=RE_COORDINATE):
|
||||
|
||||
for _event, element in p:
|
||||
|
||||
if element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}c':
|
||||
coord = element.get('r')
|
||||
column_str, row = _re_coordinate.match(coord).groups()
|
||||
|
||||
row = int(row)
|
||||
column = column_index_from_string(column_str)
|
||||
|
||||
if min_col <= column <= max_col and min_row <= row <= max_row:
|
||||
data_type = element.get('t', 'n')
|
||||
style_id = element.get('s')
|
||||
value = element.findtext('{http://schemas.openxmlformats.org/spreadsheetml/2006/main}v')
|
||||
yield RawCell(row, column_str, coord, value, data_type, style_id, None)
|
||||
|
||||
if element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}v':
|
||||
continue
|
||||
element.clear()
|
||||
|
||||
|
||||
|
||||
def get_range_boundaries(range_string, row = 0, column = 0):
|
||||
|
||||
if ':' in range_string:
|
||||
min_range, max_range = range_string.split(':')
|
||||
min_col, min_row = coordinate_from_string(min_range)
|
||||
max_col, max_row = coordinate_from_string(max_range)
|
||||
|
||||
min_col = column_index_from_string(min_col) + column
|
||||
max_col = column_index_from_string(max_col) + column
|
||||
min_row += row
|
||||
max_row += row
|
||||
|
||||
else:
|
||||
min_col, min_row = coordinate_from_string(range_string)
|
||||
min_col = column_index_from_string(min_col)
|
||||
max_col = min_col + 1
|
||||
max_row = min_row
|
||||
|
||||
return (min_col, min_row, max_col, max_row)
|
||||
|
||||
def get_archive_file(archive_name):
|
||||
|
||||
return ZipFile(archive_name, 'r')
|
||||
|
||||
def get_xml_source(archive_file, sheet_name):
|
||||
|
||||
return archive_file.read('%s/%s' % (PACKAGE_WORKSHEETS, sheet_name))
|
||||
|
||||
def get_missing_cells(row, columns):
|
||||
|
||||
return dict([(column, RawCell(row, column, '%s%s' % (column, row), MISSING_VALUE, TYPE_NULL, None, None)) for column in columns])
|
||||
|
||||
def get_squared_range(p, min_col, min_row, max_col, max_row, string_table, style_table):
|
||||
|
||||
expected_columns = [get_column_letter(ci) for ci in xrange(min_col, max_col)]
|
||||
|
||||
current_row = min_row
|
||||
for row, cells in get_rows(p, min_row = min_row, max_row = max_row, min_column = min_col, max_column = max_col):
|
||||
full_row = []
|
||||
if current_row < row:
|
||||
|
||||
for gap_row in xrange(current_row, row):
|
||||
|
||||
dummy_cells = get_missing_cells(gap_row, expected_columns)
|
||||
|
||||
yield tuple([dummy_cells[column] for column in expected_columns])
|
||||
|
||||
current_row = row
|
||||
|
||||
temp_cells = list(cells)
|
||||
|
||||
retrieved_columns = dict([(c.column, c) for c in temp_cells])
|
||||
|
||||
missing_columns = list(set(expected_columns) - set(retrieved_columns.keys()))
|
||||
|
||||
replacement_columns = get_missing_cells(row, missing_columns)
|
||||
|
||||
for column in expected_columns:
|
||||
|
||||
if column in retrieved_columns:
|
||||
cell = retrieved_columns[column]
|
||||
|
||||
if cell.style_id is not None:
|
||||
style = style_table[int(cell.style_id)]
|
||||
cell = cell._replace(number_format = style.number_format.format_code) #pylint: disable-msg=W0212
|
||||
if cell.internal_value is not None:
|
||||
if cell.data_type == Cell.TYPE_STRING:
|
||||
cell = cell._replace(internal_value = string_table[int(cell.internal_value)]) #pylint: disable-msg=W0212
|
||||
elif cell.data_type == Cell.TYPE_BOOL:
|
||||
cell = cell._replace(internal_value = cell.internal_value == 'True')
|
||||
elif cell.is_date:
|
||||
cell = cell._replace(internal_value = SHARED_DATE.from_julian(float(cell.internal_value)))
|
||||
elif cell.data_type == Cell.TYPE_NUMERIC:
|
||||
cell = cell._replace(internal_value = float(cell.internal_value))
|
||||
full_row.append(cell)
|
||||
|
||||
else:
|
||||
full_row.append(replacement_columns[column])
|
||||
|
||||
current_row = row + 1
|
||||
|
||||
yield tuple(full_row)
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
class IterableWorksheet(Worksheet):
|
||||
|
||||
def __init__(self, parent_workbook, title, workbook_name,
|
||||
sheet_codename, xml_source):
|
||||
|
||||
Worksheet.__init__(self, parent_workbook, title)
|
||||
self._workbook_name = workbook_name
|
||||
self._sheet_codename = sheet_codename
|
||||
self._xml_source = xml_source
|
||||
|
||||
def iter_rows(self, range_string = '', row_offset = 0, column_offset = 0):
|
||||
""" Returns a squared range based on the `range_string` parameter,
|
||||
using generators.
|
||||
|
||||
:param range_string: range of cells (e.g. 'A1:C4')
|
||||
:type range_string: string
|
||||
|
||||
:param row: row index of the cell (e.g. 4)
|
||||
:type row: int
|
||||
|
||||
:param column: column index of the cell (e.g. 3)
|
||||
:type column: int
|
||||
|
||||
:rtype: generator
|
||||
|
||||
"""
|
||||
|
||||
return iter_rows(workbook_name = self._workbook_name,
|
||||
sheet_name = self._sheet_codename,
|
||||
xml_source = self._xml_source,
|
||||
range_string = range_string,
|
||||
row_offset = row_offset,
|
||||
column_offset = column_offset)
|
||||
|
||||
def cell(self, *args, **kwargs):
|
||||
|
||||
raise NotImplementedError("use 'iter_rows()' instead")
|
||||
|
||||
def range(self, *args, **kwargs):
|
||||
|
||||
raise NotImplementedError("use 'iter_rows()' instead")
|
||||
|
||||
def unpack_worksheet(archive, filename):
|
||||
|
||||
temp_file = tempfile.TemporaryFile(mode='r+', prefix='openpyxl.', suffix='.unpack.temp')
|
||||
|
||||
zinfo = archive.getinfo(filename)
|
||||
|
||||
if zinfo.compress_type == zipfile.ZIP_STORED:
|
||||
decoder = None
|
||||
elif zinfo.compress_type == zipfile.ZIP_DEFLATED:
|
||||
decoder = zlib.decompressobj(-zlib.MAX_WBITS)
|
||||
else:
|
||||
raise zipfile.BadZipFile("Unrecognized compression method")
|
||||
|
||||
archive.fp.seek(_get_file_offset(archive, zinfo))
|
||||
bytes_to_read = zinfo.compress_size
|
||||
|
||||
while True:
|
||||
buff = archive.fp.read(min(bytes_to_read, 102400))
|
||||
if not buff:
|
||||
break
|
||||
bytes_to_read -= len(buff)
|
||||
if decoder:
|
||||
buff = decoder.decompress(buff)
|
||||
temp_file.write(buff)
|
||||
|
||||
if decoder:
|
||||
temp_file.write(decoder.decompress('Z'))
|
||||
|
||||
return temp_file
|
||||
|
||||
def _get_file_offset(archive, zinfo):
|
||||
|
||||
try:
|
||||
return zinfo.file_offset
|
||||
except AttributeError:
|
||||
# From http://stackoverflow.com/questions/3781261/how-to-simulate-zipfile-open-in-python-2-5
|
||||
|
||||
# Seek over the fixed size fields to the "file name length" field in
|
||||
# the file header (26 bytes). Unpack this and the "extra field length"
|
||||
# field ourselves as info.extra doesn't seem to be the correct length.
|
||||
archive.fp.seek(zinfo.header_offset + 26)
|
||||
file_name_len, extra_len = struct.unpack("<HH", archive.fp.read(4))
|
||||
return zinfo.header_offset + 30 + file_name_len + extra_len
|
||||
@@ -0,0 +1,64 @@
|
||||
# file openpyxl/reader/strings.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read the shared strings table."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, QName
|
||||
from ..shared.ooxml import NAMESPACES
|
||||
|
||||
|
||||
def read_string_table(xml_source):
|
||||
"""Read in all shared strings in the table"""
|
||||
table = {}
|
||||
xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
|
||||
root = fromstring(text=xml_source)
|
||||
string_index_nodes = root.findall(QName(xmlns, 'si').text)
|
||||
for index, string_index_node in enumerate(string_index_nodes):
|
||||
table[index] = get_string(xmlns, string_index_node)
|
||||
return table
|
||||
|
||||
|
||||
def get_string(xmlns, string_index_node):
|
||||
"""Read the contents of a specific string index"""
|
||||
rich_nodes = string_index_node.findall(QName(xmlns, 'r').text)
|
||||
if rich_nodes:
|
||||
reconstructed_text = []
|
||||
for rich_node in rich_nodes:
|
||||
partial_text = get_text(xmlns, rich_node)
|
||||
reconstructed_text.append(partial_text)
|
||||
return ''.join(reconstructed_text)
|
||||
else:
|
||||
return get_text(xmlns, string_index_node)
|
||||
|
||||
|
||||
def get_text(xmlns, rich_node):
|
||||
"""Read rich text, discarding formatting if not disallowed"""
|
||||
text_node = rich_node.find(QName(xmlns, 't').text)
|
||||
partial_text = text_node.text or ''
|
||||
|
||||
if text_node.get(QName(NAMESPACES['xml'], 'space').text) != 'preserve':
|
||||
partial_text = partial_text.strip()
|
||||
return unicode(partial_text)
|
||||
@@ -0,0 +1,69 @@
|
||||
# file openpyxl/reader/style.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read shared style definitions"""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, QName
|
||||
from ..shared.exc import MissingNumberFormat
|
||||
from ..style import Style, NumberFormat
|
||||
|
||||
|
||||
def read_style_table(xml_source):
|
||||
"""Read styles from the shared style table"""
|
||||
table = {}
|
||||
xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
|
||||
root = fromstring(xml_source)
|
||||
custom_num_formats = parse_custom_num_formats(root, xmlns)
|
||||
builtin_formats = NumberFormat._BUILTIN_FORMATS
|
||||
cell_xfs = root.find(QName(xmlns, 'cellXfs').text)
|
||||
cell_xfs_nodes = cell_xfs.findall(QName(xmlns, 'xf').text)
|
||||
for index, cell_xfs_node in enumerate(cell_xfs_nodes):
|
||||
new_style = Style()
|
||||
number_format_id = int(cell_xfs_node.get('numFmtId'))
|
||||
if number_format_id < 164:
|
||||
new_style.number_format.format_code = \
|
||||
builtin_formats.get(number_format_id, 'General')
|
||||
else:
|
||||
|
||||
if number_format_id in custom_num_formats:
|
||||
new_style.number_format.format_code = \
|
||||
custom_num_formats[number_format_id]
|
||||
else:
|
||||
raise MissingNumberFormat('%s' % number_format_id)
|
||||
table[index] = new_style
|
||||
return table
|
||||
|
||||
|
||||
def parse_custom_num_formats(root, xmlns):
|
||||
"""Read in custom numeric formatting rules from the shared style table"""
|
||||
custom_formats = {}
|
||||
num_fmts = root.find(QName(xmlns, 'numFmts').text)
|
||||
if num_fmts is not None:
|
||||
num_fmt_nodes = num_fmts.findall(QName(xmlns, 'numFmt').text)
|
||||
for num_fmt_node in num_fmt_nodes:
|
||||
custom_formats[int(num_fmt_node.get('numFmtId'))] = \
|
||||
num_fmt_node.get('formatCode')
|
||||
return custom_formats
|
||||
@@ -0,0 +1,156 @@
|
||||
# file openpyxl/reader/workbook.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read in global settings to be maintained by the workbook object."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, QName
|
||||
from ..shared.ooxml import NAMESPACES
|
||||
from ..workbook import DocumentProperties
|
||||
from ..shared.date_time import W3CDTF_to_datetime
|
||||
from ..namedrange import NamedRange, split_named_range
|
||||
|
||||
import datetime
|
||||
|
||||
# constants
|
||||
BUGGY_NAMED_RANGES = ['NA()', '#REF!']
|
||||
DISCARDED_RANGES = ['Excel_BuiltIn', 'Print_Area']
|
||||
|
||||
def get_sheet_ids(xml_source):
|
||||
|
||||
sheet_names = read_sheets_titles(xml_source)
|
||||
|
||||
return dict((sheet, 'sheet%d.xml' % (i + 1)) for i, sheet in enumerate(sheet_names))
|
||||
|
||||
|
||||
def read_properties_core(xml_source):
|
||||
"""Read assorted file properties."""
|
||||
properties = DocumentProperties()
|
||||
root = fromstring(xml_source)
|
||||
creator_node = root.find(QName(NAMESPACES['dc'], 'creator').text)
|
||||
if creator_node is not None:
|
||||
properties.creator = creator_node.text
|
||||
else:
|
||||
properties.creator = ''
|
||||
last_modified_by_node = root.find(
|
||||
QName(NAMESPACES['cp'], 'lastModifiedBy').text)
|
||||
if last_modified_by_node is not None:
|
||||
properties.last_modified_by = last_modified_by_node.text
|
||||
else:
|
||||
properties.last_modified_by = ''
|
||||
|
||||
created_node = root.find(QName(NAMESPACES['dcterms'], 'created').text)
|
||||
if created_node is not None:
|
||||
properties.created = W3CDTF_to_datetime(created_node.text)
|
||||
else:
|
||||
properties.created = datetime.datetime.now()
|
||||
|
||||
modified_node = root.find(QName(NAMESPACES['dcterms'], 'modified').text)
|
||||
if modified_node is not None:
|
||||
properties.modified = W3CDTF_to_datetime(modified_node.text)
|
||||
else:
|
||||
properties.modified = properties.created
|
||||
|
||||
return properties
|
||||
|
||||
|
||||
def get_number_of_parts(xml_source):
|
||||
"""Get a list of contents of the workbook."""
|
||||
parts_size = {}
|
||||
parts_names = []
|
||||
root = fromstring(xml_source)
|
||||
heading_pairs = root.find(QName('http://schemas.openxmlformats.org/officeDocument/2006/extended-properties',
|
||||
'HeadingPairs').text)
|
||||
vector = heading_pairs.find(QName(NAMESPACES['vt'], 'vector').text)
|
||||
children = vector.getchildren()
|
||||
for child_id in range(0, len(children), 2):
|
||||
part_name = children[child_id].find(QName(NAMESPACES['vt'],
|
||||
'lpstr').text).text
|
||||
if not part_name in parts_names:
|
||||
parts_names.append(part_name)
|
||||
part_size = int(children[child_id + 1].find(QName(
|
||||
NAMESPACES['vt'], 'i4').text).text)
|
||||
parts_size[part_name] = part_size
|
||||
return parts_size, parts_names
|
||||
|
||||
|
||||
def read_sheets_titles(xml_source):
|
||||
"""Read titles for all sheets."""
|
||||
root = fromstring(xml_source)
|
||||
titles_root = root.find(QName('http://schemas.openxmlformats.org/officeDocument/2006/extended-properties',
|
||||
'TitlesOfParts').text)
|
||||
vector = titles_root.find(QName(NAMESPACES['vt'], 'vector').text)
|
||||
parts, names = get_number_of_parts(xml_source)
|
||||
|
||||
# we can't assume 'Worksheets' to be written in english,
|
||||
# but it's always the first item of the parts list (see bug #22)
|
||||
size = parts[names[0]]
|
||||
children = [c.text for c in vector.getchildren()]
|
||||
return children[:size]
|
||||
|
||||
|
||||
def read_named_ranges(xml_source, workbook):
|
||||
"""Read named ranges, excluding poorly defined ranges."""
|
||||
named_ranges = []
|
||||
root = fromstring(xml_source)
|
||||
names_root = root.find(QName('http://schemas.openxmlformats.org/spreadsheetml/2006/main',
|
||||
'definedNames').text)
|
||||
if names_root is not None:
|
||||
|
||||
for name_node in names_root.getchildren():
|
||||
range_name = name_node.get('name')
|
||||
|
||||
if name_node.get("hidden", '0') == '1':
|
||||
continue
|
||||
|
||||
valid = True
|
||||
|
||||
for discarded_range in DISCARDED_RANGES:
|
||||
if discarded_range in range_name:
|
||||
valid = False
|
||||
|
||||
for bad_range in BUGGY_NAMED_RANGES:
|
||||
if bad_range in name_node.text:
|
||||
valid = False
|
||||
|
||||
if valid:
|
||||
destinations = split_named_range(name_node.text)
|
||||
|
||||
new_destinations = []
|
||||
for worksheet, cells_range in destinations:
|
||||
|
||||
# it can happen that a valid named range references
|
||||
# a missing worksheet, when Excel didn't properly maintain
|
||||
# the named range list
|
||||
#
|
||||
# we just ignore them here
|
||||
worksheet = workbook.get_sheet_by_name(worksheet)
|
||||
if worksheet:
|
||||
new_destinations.append((worksheet, cells_range))
|
||||
|
||||
named_range = NamedRange(range_name, new_destinations)
|
||||
named_ranges.append(named_range)
|
||||
|
||||
return named_ranges
|
||||
@@ -0,0 +1,114 @@
|
||||
# file openpyxl/reader/worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Reader for a single worksheet."""
|
||||
|
||||
# Python stdlib imports
|
||||
try:
|
||||
from xml.etree.cElementTree import iterparse
|
||||
except ImportError:
|
||||
from xml.etree.ElementTree import iterparse
|
||||
|
||||
from ....compat import ifilter
|
||||
from ....compat import BytesIO as StringIO
|
||||
|
||||
# package imports
|
||||
from ..cell import Cell, coordinate_from_string
|
||||
from ..worksheet import Worksheet
|
||||
|
||||
def _get_xml_iter(xml_source):
|
||||
|
||||
if not hasattr(xml_source, 'name'):
|
||||
return StringIO(xml_source)
|
||||
else:
|
||||
xml_source.seek(0)
|
||||
return xml_source
|
||||
|
||||
def read_dimension(xml_source):
|
||||
|
||||
source = _get_xml_iter(xml_source)
|
||||
|
||||
it = iterparse(source)
|
||||
|
||||
for event, element in it:
|
||||
|
||||
if element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}dimension':
|
||||
ref = element.get('ref')
|
||||
|
||||
min_range, max_range = ref.split(':')
|
||||
min_col, min_row = coordinate_from_string(min_range)
|
||||
max_col, max_row = coordinate_from_string(max_range)
|
||||
|
||||
return min_col, min_row, max_col, max_row
|
||||
|
||||
else:
|
||||
element.clear()
|
||||
|
||||
return None
|
||||
|
||||
def filter_cells(x):
|
||||
(event, element) = x
|
||||
|
||||
return element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}c'
|
||||
|
||||
def fast_parse(ws, xml_source, string_table, style_table):
|
||||
|
||||
source = _get_xml_iter(xml_source)
|
||||
|
||||
it = iterparse(source)
|
||||
|
||||
for event, element in ifilter(filter_cells, it):
|
||||
|
||||
value = element.findtext('{http://schemas.openxmlformats.org/spreadsheetml/2006/main}v')
|
||||
|
||||
if value is not None:
|
||||
|
||||
coordinate = element.get('r')
|
||||
data_type = element.get('t', 'n')
|
||||
style_id = element.get('s')
|
||||
|
||||
if data_type == Cell.TYPE_STRING:
|
||||
value = string_table.get(int(value))
|
||||
|
||||
ws.cell(coordinate).value = value
|
||||
|
||||
if style_id is not None:
|
||||
ws._styles[coordinate] = style_table.get(int(style_id))
|
||||
|
||||
# to avoid memory exhaustion, clear the item after use
|
||||
element.clear()
|
||||
|
||||
from ..reader.iter_worksheet import IterableWorksheet
|
||||
|
||||
def read_worksheet(xml_source, parent, preset_title, string_table,
|
||||
style_table, workbook_name = None, sheet_codename = None):
|
||||
"""Read an xml worksheet"""
|
||||
if workbook_name and sheet_codename:
|
||||
ws = IterableWorksheet(parent, preset_title, workbook_name,
|
||||
sheet_codename, xml_source)
|
||||
else:
|
||||
ws = Worksheet(parent, preset_title)
|
||||
fast_parse(ws, xml_source, string_table, style_table)
|
||||
return ws
|
||||
@@ -0,0 +1,33 @@
|
||||
# file openpyxl/shared/__init__.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Imports for the openpyxl.shared namespace."""
|
||||
|
||||
# package imports
|
||||
from . import date_time
|
||||
from . import exc
|
||||
from . import ooxml
|
||||
from . import password_hasher
|
||||
from . import xmltools
|
||||
@@ -0,0 +1,154 @@
|
||||
# file openpyxl/shared/date_time.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Manage Excel date weirdness."""
|
||||
|
||||
# Python stdlib imports
|
||||
from __future__ import division
|
||||
from math import floor
|
||||
import calendar
|
||||
import datetime
|
||||
import time
|
||||
import re
|
||||
|
||||
# constants
|
||||
W3CDTF_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
|
||||
|
||||
RE_W3CDTF = '(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(.(\d{2}))?Z'
|
||||
|
||||
EPOCH = datetime.datetime.utcfromtimestamp(0)
|
||||
|
||||
def datetime_to_W3CDTF(dt):
|
||||
"""Convert from a datetime to a timestamp string."""
|
||||
return datetime.datetime.strftime(dt, W3CDTF_FORMAT)
|
||||
|
||||
|
||||
def W3CDTF_to_datetime(formatted_string):
|
||||
"""Convert from a timestamp string to a datetime object."""
|
||||
match = re.match(RE_W3CDTF,formatted_string)
|
||||
digits = map(int, match.groups()[:6])
|
||||
return datetime.datetime(*digits)
|
||||
|
||||
|
||||
class SharedDate(object):
|
||||
"""Date formatting utilities for Excel with shared state.
|
||||
|
||||
Excel has a two primary date tracking schemes:
|
||||
Windows - Day 1 == 1900-01-01
|
||||
Mac - Day 1 == 1904-01-01
|
||||
|
||||
SharedDate stores which system we are using and converts dates between
|
||||
Python and Excel accordingly.
|
||||
|
||||
"""
|
||||
CALENDAR_WINDOWS_1900 = 1900
|
||||
CALENDAR_MAC_1904 = 1904
|
||||
datetime_object_type = 'DateTime'
|
||||
|
||||
def __init__(self):
|
||||
self.excel_base_date = self.CALENDAR_WINDOWS_1900
|
||||
|
||||
def datetime_to_julian(self, date):
|
||||
"""Convert from python datetime to excel julian date representation."""
|
||||
|
||||
if isinstance(date, datetime.datetime):
|
||||
return self.to_julian(date.year, date.month, date.day, \
|
||||
hours=date.hour, minutes=date.minute, seconds=date.second)
|
||||
elif isinstance(date, datetime.date):
|
||||
return self.to_julian(date.year, date.month, date.day)
|
||||
|
||||
def to_julian(self, year, month, day, hours=0, minutes=0, seconds=0):
|
||||
"""Convert from Python date to Excel JD."""
|
||||
# explicitly disallow bad years
|
||||
# Excel 2000 treats JD=0 as 1/0/1900 (buggy, disallow)
|
||||
# Excel 2000 treats JD=2958466 as a bad date (Y10K bug!)
|
||||
if year < 1900 or year > 10000:
|
||||
msg = 'Year not supported by Excel: %s' % year
|
||||
raise ValueError(msg)
|
||||
if self.excel_base_date == self.CALENDAR_WINDOWS_1900:
|
||||
# Fudge factor for the erroneous fact that the year 1900 is
|
||||
# treated as a Leap Year in MS Excel. This affects every date
|
||||
# following 28th February 1900
|
||||
if year == 1900 and month <= 2:
|
||||
excel_1900_leap_year = False
|
||||
else:
|
||||
excel_1900_leap_year = True
|
||||
excel_base_date = 2415020
|
||||
else:
|
||||
raise NotImplementedError('Mac dates are not yet supported.')
|
||||
#excel_base_date = 2416481
|
||||
#excel_1900_leap_year = False
|
||||
|
||||
# Julian base date adjustment
|
||||
if month > 2:
|
||||
month = month - 3
|
||||
else:
|
||||
month = month + 9
|
||||
year -= 1
|
||||
|
||||
# Calculate the Julian Date, then subtract the Excel base date
|
||||
# JD 2415020 = 31 - Dec - 1899 -> Excel Date of 0
|
||||
century, decade = int(str(year)[:2]), int(str(year)[2:])
|
||||
excel_date = floor(146097 * century / 4) + \
|
||||
floor((1461 * decade) / 4) + floor((153 * month + 2) / 5) + \
|
||||
day + 1721119 - excel_base_date
|
||||
if excel_1900_leap_year:
|
||||
excel_date += 1
|
||||
|
||||
# check to ensure that we exclude 2/29/1900 as a possible value
|
||||
if self.excel_base_date == self.CALENDAR_WINDOWS_1900 \
|
||||
and excel_date == 60:
|
||||
msg = 'Error: Excel believes 1900 was a leap year'
|
||||
raise ValueError(msg)
|
||||
excel_time = ((hours * 3600) + (minutes * 60) + seconds) / 86400
|
||||
return excel_date + excel_time
|
||||
|
||||
def from_julian(self, value=0):
|
||||
"""Convert from the Excel JD back to a date"""
|
||||
if self.excel_base_date == self.CALENDAR_WINDOWS_1900:
|
||||
excel_base_date = 25569
|
||||
if value < 60:
|
||||
excel_base_date -= 1
|
||||
elif value == 60:
|
||||
msg = 'Error: Excel believes 1900 was a leap year'
|
||||
raise ValueError(msg)
|
||||
else:
|
||||
raise NotImplementedError('Mac dates are not yet supported.')
|
||||
#excel_base_date = 24107
|
||||
|
||||
if value >= 1:
|
||||
utc_days = value - excel_base_date
|
||||
|
||||
return EPOCH + datetime.timedelta(days=utc_days)
|
||||
|
||||
elif value >= 0:
|
||||
hours = floor(value * 24)
|
||||
mins = floor(value * 24 * 60) - floor(hours * 60)
|
||||
secs = floor(value * 24 * 60 * 60) - floor(hours * 60 * 60) - \
|
||||
floor(mins * 60)
|
||||
return datetime.time(int(hours), int(mins), int(secs))
|
||||
else:
|
||||
msg = 'Negative dates (%s) are not supported' % value
|
||||
raise ValueError(msg)
|
||||
@@ -0,0 +1,59 @@
|
||||
# file openpyxl/shared/exc.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Definitions for openpyxl shared exception classes."""
|
||||
|
||||
|
||||
class CellCoordinatesException(Exception):
|
||||
"""Error for converting between numeric and A1-style cell references."""
|
||||
|
||||
class ColumnStringIndexException(Exception):
|
||||
"""Error for bad column names in A1-style cell references."""
|
||||
|
||||
class DataTypeException(Exception):
|
||||
"""Error for any data type inconsistencies."""
|
||||
|
||||
class NamedRangeException(Exception):
|
||||
"""Error for badly formatted named ranges."""
|
||||
|
||||
class SheetTitleException(Exception):
|
||||
"""Error for bad sheet names."""
|
||||
|
||||
class InsufficientCoordinatesException(Exception):
|
||||
"""Error for partially specified cell coordinates."""
|
||||
|
||||
class OpenModeError(Exception):
|
||||
"""Error for fileobj opened in non-binary mode."""
|
||||
|
||||
class InvalidFileException(Exception):
|
||||
"""Error for trying to open a non-ooxml file."""
|
||||
|
||||
class ReadOnlyWorkbookException(Exception):
|
||||
"""Error for trying to modify a read-only workbook"""
|
||||
|
||||
class MissingNumberFormat(Exception):
|
||||
"""Error when a referenced number format is not in the stylesheet"""
|
||||
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
# file openpyxl/shared/ooxml.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Constants for fixed paths in a file and xml namespace urls."""
|
||||
|
||||
MIN_ROW = 0
|
||||
MIN_COLUMN = 0
|
||||
MAX_COLUMN = 16384
|
||||
MAX_ROW = 1048576
|
||||
|
||||
# constants
|
||||
PACKAGE_PROPS = 'docProps'
|
||||
PACKAGE_XL = 'xl'
|
||||
PACKAGE_RELS = '_rels'
|
||||
PACKAGE_THEME = PACKAGE_XL + '/' + 'theme'
|
||||
PACKAGE_WORKSHEETS = PACKAGE_XL + '/' + 'worksheets'
|
||||
PACKAGE_DRAWINGS = PACKAGE_XL + '/' + 'drawings'
|
||||
PACKAGE_CHARTS = PACKAGE_XL + '/' + 'charts'
|
||||
|
||||
ARC_CONTENT_TYPES = '[Content_Types].xml'
|
||||
ARC_ROOT_RELS = PACKAGE_RELS + '/.rels'
|
||||
ARC_WORKBOOK_RELS = PACKAGE_XL + '/' + PACKAGE_RELS + '/workbook.xml.rels'
|
||||
ARC_CORE = PACKAGE_PROPS + '/core.xml'
|
||||
ARC_APP = PACKAGE_PROPS + '/app.xml'
|
||||
ARC_WORKBOOK = PACKAGE_XL + '/workbook.xml'
|
||||
ARC_STYLE = PACKAGE_XL + '/styles.xml'
|
||||
ARC_THEME = PACKAGE_THEME + '/theme1.xml'
|
||||
ARC_SHARED_STRINGS = PACKAGE_XL + '/sharedStrings.xml'
|
||||
|
||||
NAMESPACES = {
|
||||
'cp': 'http://schemas.openxmlformats.org/package/2006/metadata/core-properties',
|
||||
'dc': 'http://purl.org/dc/elements/1.1/',
|
||||
'dcterms': 'http://purl.org/dc/terms/',
|
||||
'dcmitype': 'http://purl.org/dc/dcmitype/',
|
||||
'xsi': 'http://www.w3.org/2001/XMLSchema-instance',
|
||||
'vt': 'http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes',
|
||||
'xml': 'http://www.w3.org/XML/1998/namespace'
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
# file openpyxl/shared/password_hasher.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Basic password hashing."""
|
||||
|
||||
|
||||
def hash_password(plaintext_password=''):
|
||||
"""Create a password hash from a given string.
|
||||
|
||||
This method is based on the algorithm provided by
|
||||
Daniel Rentz of OpenOffice and the PEAR package
|
||||
Spreadsheet_Excel_Writer by Xavier Noguer <xnoguer@rezebra.com>.
|
||||
|
||||
"""
|
||||
password = 0x0000
|
||||
i = 1
|
||||
for char in plaintext_password:
|
||||
value = ord(char) << i
|
||||
rotated_bits = value >> 15
|
||||
value &= 0x7fff
|
||||
password ^= (value | rotated_bits)
|
||||
i += 1
|
||||
password ^= len(plaintext_password)
|
||||
password ^= 0xCE4B
|
||||
return str(hex(password)).upper()[2:]
|
||||
@@ -0,0 +1,67 @@
|
||||
# file openpyxl/shared/units.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
import math
|
||||
|
||||
def pixels_to_EMU(value):
|
||||
return int(round(value * 9525))
|
||||
|
||||
def EMU_to_pixels(value):
|
||||
if not value:
|
||||
return 0
|
||||
else:
|
||||
return round(value / 9525.)
|
||||
|
||||
def EMU_to_cm(value):
|
||||
if not value:
|
||||
return 0
|
||||
else:
|
||||
return (EMU_to_pixels(value) * 2.57 / 96)
|
||||
|
||||
def pixels_to_points(value):
|
||||
return value * 0.67777777
|
||||
|
||||
def points_to_pixels(value):
|
||||
if not value:
|
||||
return 0
|
||||
else:
|
||||
return int(math.ceil(value * 1.333333333))
|
||||
|
||||
def degrees_to_angle(value):
|
||||
return int(round(value * 60000))
|
||||
|
||||
def angle_to_degrees(value):
|
||||
if not value:
|
||||
return 0
|
||||
else:
|
||||
return round(value / 60000.)
|
||||
|
||||
def short_color(color):
|
||||
""" format a color to its short size """
|
||||
|
||||
if len(color) > 6:
|
||||
return color[2:]
|
||||
else:
|
||||
return color
|
||||
@@ -0,0 +1,114 @@
|
||||
# file openpyxl/shared/xmltools.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Shared xml tools.
|
||||
|
||||
Shortcut functions taken from:
|
||||
http://lethain.com/entry/2009/jan/22/handling-very-large-csv-and-xml-files-in-python/
|
||||
|
||||
"""
|
||||
|
||||
# Python stdlib imports
|
||||
from xml.sax.xmlreader import AttributesNSImpl
|
||||
from xml.sax.saxutils import XMLGenerator
|
||||
try:
|
||||
from xml.etree.ElementTree import ElementTree, Element, SubElement, \
|
||||
QName, fromstring, tostring
|
||||
except ImportError:
|
||||
from cElementTree import ElementTree, Element, SubElement, \
|
||||
QName, fromstring, tostring
|
||||
|
||||
# package imports
|
||||
from .. import __name__ as prefix
|
||||
|
||||
|
||||
def get_document_content(xml_node):
|
||||
"""Print nicely formatted xml to a string."""
|
||||
pretty_indent(xml_node)
|
||||
return tostring(xml_node, 'utf-8')
|
||||
|
||||
|
||||
def pretty_indent(elem, level=0):
|
||||
"""Format xml with nice indents and line breaks."""
|
||||
i = "\n" + level * " "
|
||||
if len(elem):
|
||||
if not elem.text or not elem.text.strip():
|
||||
elem.text = i + " "
|
||||
if not elem.tail or not elem.tail.strip():
|
||||
elem.tail = i
|
||||
for elem in elem:
|
||||
pretty_indent(elem, level + 1)
|
||||
if not elem.tail or not elem.tail.strip():
|
||||
elem.tail = i
|
||||
else:
|
||||
if level and (not elem.tail or not elem.tail.strip()):
|
||||
elem.tail = i
|
||||
|
||||
|
||||
def start_tag(doc, name, attr=None, body=None, namespace=None):
|
||||
"""Wrapper to start an xml tag."""
|
||||
if attr is None:
|
||||
attr = {}
|
||||
|
||||
|
||||
# name = bytes(name, 'utf-8')
|
||||
|
||||
# if namespace is not None:
|
||||
# namespace = bytes(namespace, 'utf-8')
|
||||
|
||||
|
||||
attr_vals = {}
|
||||
attr_keys = {}
|
||||
for key, val in attr.items():
|
||||
|
||||
|
||||
# if key is not None:
|
||||
# key = bytes(key, 'utf-8')
|
||||
|
||||
# if val is not None:
|
||||
# val = bytes(val, 'utf-8')
|
||||
|
||||
key_tuple = (namespace, key)
|
||||
|
||||
attr_vals[key_tuple] = val
|
||||
attr_keys[key_tuple] = key
|
||||
|
||||
attr2 = AttributesNSImpl(attr_vals, attr_keys)
|
||||
doc.startElementNS((namespace, name), name, attr2)
|
||||
if body:
|
||||
doc.characters(body)
|
||||
|
||||
|
||||
def end_tag(doc, name, namespace=None):
|
||||
"""Wrapper to close an xml tag."""
|
||||
doc.endElementNS((namespace, name), name)
|
||||
|
||||
|
||||
def tag(doc, name, attr=None, body=None, namespace=None):
|
||||
"""Wrapper to print xml tags and comments."""
|
||||
if attr is None:
|
||||
attr = {}
|
||||
start_tag(doc, name, attr, body, namespace)
|
||||
end_tag(doc, name, namespace)
|
||||
@@ -0,0 +1,392 @@
|
||||
# file openpyxl/style.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Style and formatting option tracking."""
|
||||
|
||||
# Python stdlib imports
|
||||
import re
|
||||
try:
|
||||
from hashlib import md5
|
||||
except ImportError:
|
||||
from md5 import md5
|
||||
|
||||
|
||||
class HashableObject(object):
|
||||
"""Define how to hash property classes."""
|
||||
__fields__ = None
|
||||
__leaf__ = False
|
||||
|
||||
def __repr__(self):
|
||||
|
||||
return ':'.join([repr(getattr(self, x)) for x in self.__fields__])
|
||||
|
||||
def __hash__(self):
|
||||
|
||||
# return int(md5(repr(self)).hexdigest(), 16)
|
||||
return hash(repr(self))
|
||||
|
||||
class Color(HashableObject):
|
||||
"""Named colors for use in styles."""
|
||||
BLACK = 'FF000000'
|
||||
WHITE = 'FFFFFFFF'
|
||||
RED = 'FFFF0000'
|
||||
DARKRED = 'FF800000'
|
||||
BLUE = 'FF0000FF'
|
||||
DARKBLUE = 'FF000080'
|
||||
GREEN = 'FF00FF00'
|
||||
DARKGREEN = 'FF008000'
|
||||
YELLOW = 'FFFFFF00'
|
||||
DARKYELLOW = 'FF808000'
|
||||
|
||||
__fields__ = ('index',)
|
||||
__slots__ = __fields__
|
||||
__leaf__ = True
|
||||
|
||||
def __init__(self, index):
|
||||
super(Color, self).__init__()
|
||||
self.index = index
|
||||
|
||||
|
||||
class Font(HashableObject):
|
||||
"""Font options used in styles."""
|
||||
UNDERLINE_NONE = 'none'
|
||||
UNDERLINE_DOUBLE = 'double'
|
||||
UNDERLINE_DOUBLE_ACCOUNTING = 'doubleAccounting'
|
||||
UNDERLINE_SINGLE = 'single'
|
||||
UNDERLINE_SINGLE_ACCOUNTING = 'singleAccounting'
|
||||
|
||||
__fields__ = ('name',
|
||||
'size',
|
||||
'bold',
|
||||
'italic',
|
||||
'superscript',
|
||||
'subscript',
|
||||
'underline',
|
||||
'strikethrough',
|
||||
'color')
|
||||
__slots__ = __fields__
|
||||
|
||||
def __init__(self):
|
||||
super(Font, self).__init__()
|
||||
self.name = 'Calibri'
|
||||
self.size = 11
|
||||
self.bold = False
|
||||
self.italic = False
|
||||
self.superscript = False
|
||||
self.subscript = False
|
||||
self.underline = self.UNDERLINE_NONE
|
||||
self.strikethrough = False
|
||||
self.color = Color(Color.BLACK)
|
||||
|
||||
|
||||
class Fill(HashableObject):
|
||||
"""Area fill patterns for use in styles."""
|
||||
FILL_NONE = 'none'
|
||||
FILL_SOLID = 'solid'
|
||||
FILL_GRADIENT_LINEAR = 'linear'
|
||||
FILL_GRADIENT_PATH = 'path'
|
||||
FILL_PATTERN_DARKDOWN = 'darkDown'
|
||||
FILL_PATTERN_DARKGRAY = 'darkGray'
|
||||
FILL_PATTERN_DARKGRID = 'darkGrid'
|
||||
FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal'
|
||||
FILL_PATTERN_DARKTRELLIS = 'darkTrellis'
|
||||
FILL_PATTERN_DARKUP = 'darkUp'
|
||||
FILL_PATTERN_DARKVERTICAL = 'darkVertical'
|
||||
FILL_PATTERN_GRAY0625 = 'gray0625'
|
||||
FILL_PATTERN_GRAY125 = 'gray125'
|
||||
FILL_PATTERN_LIGHTDOWN = 'lightDown'
|
||||
FILL_PATTERN_LIGHTGRAY = 'lightGray'
|
||||
FILL_PATTERN_LIGHTGRID = 'lightGrid'
|
||||
FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal'
|
||||
FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis'
|
||||
FILL_PATTERN_LIGHTUP = 'lightUp'
|
||||
FILL_PATTERN_LIGHTVERTICAL = 'lightVertical'
|
||||
FILL_PATTERN_MEDIUMGRAY = 'mediumGray'
|
||||
|
||||
__fields__ = ('fill_type',
|
||||
'rotation',
|
||||
'start_color',
|
||||
'end_color')
|
||||
__slots__ = __fields__
|
||||
|
||||
def __init__(self):
|
||||
super(Fill, self).__init__()
|
||||
self.fill_type = self.FILL_NONE
|
||||
self.rotation = 0
|
||||
self.start_color = Color(Color.WHITE)
|
||||
self.end_color = Color(Color.BLACK)
|
||||
|
||||
|
||||
class Border(HashableObject):
|
||||
"""Border options for use in styles."""
|
||||
BORDER_NONE = 'none'
|
||||
BORDER_DASHDOT = 'dashDot'
|
||||
BORDER_DASHDOTDOT = 'dashDotDot'
|
||||
BORDER_DASHED = 'dashed'
|
||||
BORDER_DOTTED = 'dotted'
|
||||
BORDER_DOUBLE = 'double'
|
||||
BORDER_HAIR = 'hair'
|
||||
BORDER_MEDIUM = 'medium'
|
||||
BORDER_MEDIUMDASHDOT = 'mediumDashDot'
|
||||
BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot'
|
||||
BORDER_MEDIUMDASHED = 'mediumDashed'
|
||||
BORDER_SLANTDASHDOT = 'slantDashDot'
|
||||
BORDER_THICK = 'thick'
|
||||
BORDER_THIN = 'thin'
|
||||
|
||||
__fields__ = ('border_style',
|
||||
'color')
|
||||
__slots__ = __fields__
|
||||
|
||||
def __init__(self):
|
||||
super(Border, self).__init__()
|
||||
self.border_style = self.BORDER_NONE
|
||||
self.color = Color(Color.BLACK)
|
||||
|
||||
|
||||
class Borders(HashableObject):
|
||||
"""Border positioning for use in styles."""
|
||||
DIAGONAL_NONE = 0
|
||||
DIAGONAL_UP = 1
|
||||
DIAGONAL_DOWN = 2
|
||||
DIAGONAL_BOTH = 3
|
||||
|
||||
__fields__ = ('left',
|
||||
'right',
|
||||
'top',
|
||||
'bottom',
|
||||
'diagonal',
|
||||
'diagonal_direction',
|
||||
'all_borders',
|
||||
'outline',
|
||||
'inside',
|
||||
'vertical',
|
||||
'horizontal')
|
||||
__slots__ = __fields__
|
||||
|
||||
def __init__(self):
|
||||
super(Borders, self).__init__()
|
||||
self.left = Border()
|
||||
self.right = Border()
|
||||
self.top = Border()
|
||||
self.bottom = Border()
|
||||
self.diagonal = Border()
|
||||
self.diagonal_direction = self.DIAGONAL_NONE
|
||||
|
||||
self.all_borders = Border()
|
||||
self.outline = Border()
|
||||
self.inside = Border()
|
||||
self.vertical = Border()
|
||||
self.horizontal = Border()
|
||||
|
||||
|
||||
class Alignment(HashableObject):
|
||||
"""Alignment options for use in styles."""
|
||||
HORIZONTAL_GENERAL = 'general'
|
||||
HORIZONTAL_LEFT = 'left'
|
||||
HORIZONTAL_RIGHT = 'right'
|
||||
HORIZONTAL_CENTER = 'center'
|
||||
HORIZONTAL_CENTER_CONTINUOUS = 'centerContinuous'
|
||||
HORIZONTAL_JUSTIFY = 'justify'
|
||||
VERTICAL_BOTTOM = 'bottom'
|
||||
VERTICAL_TOP = 'top'
|
||||
VERTICAL_CENTER = 'center'
|
||||
VERTICAL_JUSTIFY = 'justify'
|
||||
|
||||
__fields__ = ('horizontal',
|
||||
'vertical',
|
||||
'text_rotation',
|
||||
'wrap_text',
|
||||
'shrink_to_fit',
|
||||
'indent')
|
||||
__slots__ = __fields__
|
||||
__leaf__ = True
|
||||
|
||||
def __init__(self):
|
||||
super(Alignment, self).__init__()
|
||||
self.horizontal = self.HORIZONTAL_GENERAL
|
||||
self.vertical = self.VERTICAL_BOTTOM
|
||||
self.text_rotation = 0
|
||||
self.wrap_text = False
|
||||
self.shrink_to_fit = False
|
||||
self.indent = 0
|
||||
|
||||
|
||||
class NumberFormat(HashableObject):
|
||||
"""Numer formatting for use in styles."""
|
||||
FORMAT_GENERAL = 'General'
|
||||
FORMAT_TEXT = '@'
|
||||
FORMAT_NUMBER = '0'
|
||||
FORMAT_NUMBER_00 = '0.00'
|
||||
FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00'
|
||||
FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-'
|
||||
FORMAT_PERCENTAGE = '0%'
|
||||
FORMAT_PERCENTAGE_00 = '0.00%'
|
||||
FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd'
|
||||
FORMAT_DATE_YYYYMMDD = 'yy-mm-dd'
|
||||
FORMAT_DATE_DDMMYYYY = 'dd/mm/yy'
|
||||
FORMAT_DATE_DMYSLASH = 'd/m/y'
|
||||
FORMAT_DATE_DMYMINUS = 'd-m-y'
|
||||
FORMAT_DATE_DMMINUS = 'd-m'
|
||||
FORMAT_DATE_MYMINUS = 'm-y'
|
||||
FORMAT_DATE_XLSX14 = 'mm-dd-yy'
|
||||
FORMAT_DATE_XLSX15 = 'd-mmm-yy'
|
||||
FORMAT_DATE_XLSX16 = 'd-mmm'
|
||||
FORMAT_DATE_XLSX17 = 'mmm-yy'
|
||||
FORMAT_DATE_XLSX22 = 'm/d/yy h:mm'
|
||||
FORMAT_DATE_DATETIME = 'd/m/y h:mm'
|
||||
FORMAT_DATE_TIME1 = 'h:mm AM/PM'
|
||||
FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM'
|
||||
FORMAT_DATE_TIME3 = 'h:mm'
|
||||
FORMAT_DATE_TIME4 = 'h:mm:ss'
|
||||
FORMAT_DATE_TIME5 = 'mm:ss'
|
||||
FORMAT_DATE_TIME6 = 'h:mm:ss'
|
||||
FORMAT_DATE_TIME7 = 'i:s.S'
|
||||
FORMAT_DATE_TIME8 = 'h:mm:ss@'
|
||||
FORMAT_DATE_YYYYMMDDSLASH = 'yy/mm/dd@'
|
||||
FORMAT_CURRENCY_USD_SIMPLE = '"$"#,##0.00_-'
|
||||
FORMAT_CURRENCY_USD = '$#,##0_-'
|
||||
FORMAT_CURRENCY_EUR_SIMPLE = '[$EUR ]#,##0.00_-'
|
||||
_BUILTIN_FORMATS = {
|
||||
0: 'General',
|
||||
1: '0',
|
||||
2: '0.00',
|
||||
3: '#,##0',
|
||||
4: '#,##0.00',
|
||||
|
||||
9: '0%',
|
||||
10: '0.00%',
|
||||
11: '0.00E+00',
|
||||
12: '# ?/?',
|
||||
13: '# ??/??',
|
||||
14: 'mm-dd-yy',
|
||||
15: 'd-mmm-yy',
|
||||
16: 'd-mmm',
|
||||
17: 'mmm-yy',
|
||||
18: 'h:mm AM/PM',
|
||||
19: 'h:mm:ss AM/PM',
|
||||
20: 'h:mm',
|
||||
21: 'h:mm:ss',
|
||||
22: 'm/d/yy h:mm',
|
||||
|
||||
37: '#,##0 (#,##0)',
|
||||
38: '#,##0 [Red](#,##0)',
|
||||
39: '#,##0.00(#,##0.00)',
|
||||
40: '#,##0.00[Red](#,##0.00)',
|
||||
|
||||
41: '_(* #,##0_);_(* \(#,##0\);_(* "-"_);_(@_)',
|
||||
42: '_("$"* #,##0_);_("$"* \(#,##0\);_("$"* "-"_);_(@_)',
|
||||
43: '_(* #,##0.00_);_(* \(#,##0.00\);_(* "-"??_);_(@_)',
|
||||
|
||||
44: '_("$"* #,##0.00_)_("$"* \(#,##0.00\)_("$"* "-"??_)_(@_)',
|
||||
45: 'mm:ss',
|
||||
46: '[h]:mm:ss',
|
||||
47: 'mmss.0',
|
||||
48: '##0.0E+0',
|
||||
49: '@', }
|
||||
_BUILTIN_FORMATS_REVERSE = dict(
|
||||
[(value, key) for key, value in _BUILTIN_FORMATS.items()])
|
||||
|
||||
__fields__ = ('_format_code',
|
||||
'_format_index')
|
||||
__slots__ = __fields__
|
||||
__leaf__ = True
|
||||
|
||||
DATE_INDICATORS = 'dmyhs'
|
||||
|
||||
def __init__(self):
|
||||
super(NumberFormat, self).__init__()
|
||||
self._format_code = self.FORMAT_GENERAL
|
||||
self._format_index = 0
|
||||
|
||||
def _set_format_code(self, format_code = FORMAT_GENERAL):
|
||||
"""Setter for the format_code property."""
|
||||
self._format_code = format_code
|
||||
self._format_index = self.builtin_format_id(format = format_code)
|
||||
|
||||
def _get_format_code(self):
|
||||
"""Getter for the format_code property."""
|
||||
return self._format_code
|
||||
|
||||
format_code = property(_get_format_code, _set_format_code)
|
||||
|
||||
def builtin_format_code(self, index):
|
||||
"""Return one of the standard format codes by index."""
|
||||
return self._BUILTIN_FORMATS[index]
|
||||
|
||||
def is_builtin(self, format = None):
|
||||
"""Check if a format code is a standard format code."""
|
||||
if format is None:
|
||||
format = self._format_code
|
||||
return format in self._BUILTIN_FORMATS.values()
|
||||
|
||||
def builtin_format_id(self, format):
|
||||
"""Return the id of a standard style."""
|
||||
return self._BUILTIN_FORMATS_REVERSE.get(format, None)
|
||||
|
||||
def is_date_format(self, format = None):
|
||||
"""Check if the number format is actually representing a date."""
|
||||
if format is None:
|
||||
format = self._format_code
|
||||
|
||||
return any([x in format for x in self.DATE_INDICATORS])
|
||||
|
||||
class Protection(HashableObject):
|
||||
"""Protection options for use in styles."""
|
||||
PROTECTION_INHERIT = 'inherit'
|
||||
PROTECTION_PROTECTED = 'protected'
|
||||
PROTECTION_UNPROTECTED = 'unprotected'
|
||||
|
||||
__fields__ = ('locked',
|
||||
'hidden')
|
||||
__slots__ = __fields__
|
||||
__leaf__ = True
|
||||
|
||||
def __init__(self):
|
||||
super(Protection, self).__init__()
|
||||
self.locked = self.PROTECTION_INHERIT
|
||||
self.hidden = self.PROTECTION_INHERIT
|
||||
|
||||
|
||||
class Style(HashableObject):
|
||||
"""Style object containing all formatting details."""
|
||||
__fields__ = ('font',
|
||||
'fill',
|
||||
'borders',
|
||||
'alignment',
|
||||
'number_format',
|
||||
'protection')
|
||||
__slots__ = __fields__
|
||||
|
||||
def __init__(self):
|
||||
super(Style, self).__init__()
|
||||
self.font = Font()
|
||||
self.fill = Fill()
|
||||
self.borders = Borders()
|
||||
self.alignment = Alignment()
|
||||
self.number_format = NumberFormat()
|
||||
self.protection = Protection()
|
||||
|
||||
DEFAULTS = Style()
|
||||
@@ -0,0 +1,186 @@
|
||||
# file openpyxl/workbook.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Workbook is the top-level container for all document information."""
|
||||
|
||||
__docformat__ = "restructuredtext en"
|
||||
|
||||
# Python stdlib imports
|
||||
import datetime
|
||||
import os
|
||||
|
||||
# package imports
|
||||
from .worksheet import Worksheet
|
||||
from .writer.dump_worksheet import DumpWorksheet, save_dump
|
||||
from .writer.strings import StringTableBuilder
|
||||
from .namedrange import NamedRange
|
||||
from .style import Style
|
||||
from .writer.excel import save_workbook
|
||||
from .shared.exc import ReadOnlyWorkbookException
|
||||
|
||||
|
||||
class DocumentProperties(object):
|
||||
"""High-level properties of the document."""
|
||||
|
||||
def __init__(self):
|
||||
self.creator = 'Unknown'
|
||||
self.last_modified_by = self.creator
|
||||
self.created = datetime.datetime.now()
|
||||
self.modified = datetime.datetime.now()
|
||||
self.title = 'Untitled'
|
||||
self.subject = ''
|
||||
self.description = ''
|
||||
self.keywords = ''
|
||||
self.category = ''
|
||||
self.company = 'Microsoft Corporation'
|
||||
|
||||
|
||||
class DocumentSecurity(object):
|
||||
"""Security information about the document."""
|
||||
|
||||
def __init__(self):
|
||||
self.lock_revision = False
|
||||
self.lock_structure = False
|
||||
self.lock_windows = False
|
||||
self.revision_password = ''
|
||||
self.workbook_password = ''
|
||||
|
||||
|
||||
class Workbook(object):
|
||||
"""Workbook is the container for all other parts of the document."""
|
||||
|
||||
def __init__(self, optimized_write = False):
|
||||
self.worksheets = []
|
||||
self._active_sheet_index = 0
|
||||
self._named_ranges = []
|
||||
self.properties = DocumentProperties()
|
||||
self.style = Style()
|
||||
self.security = DocumentSecurity()
|
||||
self.__optimized_write = optimized_write
|
||||
self.__optimized_read = False
|
||||
self.strings_table_builder = StringTableBuilder()
|
||||
|
||||
if not optimized_write:
|
||||
self.worksheets.append(Worksheet(self))
|
||||
|
||||
def _set_optimized_read(self):
|
||||
self.__optimized_read = True
|
||||
|
||||
def get_active_sheet(self):
|
||||
"""Returns the current active sheet."""
|
||||
return self.worksheets[self._active_sheet_index]
|
||||
|
||||
def create_sheet(self, index = None):
|
||||
"""Create a worksheet (at an optional index).
|
||||
|
||||
:param index: optional position at which the sheet will be inserted
|
||||
:type index: int
|
||||
|
||||
"""
|
||||
|
||||
if self.__optimized_read:
|
||||
raise ReadOnlyWorkbookException('Cannot create new sheet in a read-only workbook')
|
||||
|
||||
if self.__optimized_write :
|
||||
new_ws = DumpWorksheet(parent_workbook = self)
|
||||
else:
|
||||
new_ws = Worksheet(parent_workbook = self)
|
||||
|
||||
self.add_sheet(worksheet = new_ws, index = index)
|
||||
return new_ws
|
||||
|
||||
def add_sheet(self, worksheet, index = None):
|
||||
"""Add an existing worksheet (at an optional index)."""
|
||||
if index is None:
|
||||
index = len(self.worksheets)
|
||||
self.worksheets.insert(index, worksheet)
|
||||
|
||||
def remove_sheet(self, worksheet):
|
||||
"""Remove a worksheet from this workbook."""
|
||||
self.worksheets.remove(worksheet)
|
||||
|
||||
def get_sheet_by_name(self, name):
|
||||
"""Returns a worksheet by its name.
|
||||
|
||||
Returns None if no worksheet has the name specified.
|
||||
|
||||
:param name: the name of the worksheet to look for
|
||||
:type name: string
|
||||
|
||||
"""
|
||||
requested_sheet = None
|
||||
for sheet in self.worksheets:
|
||||
if sheet.title == name:
|
||||
requested_sheet = sheet
|
||||
break
|
||||
return requested_sheet
|
||||
|
||||
def get_index(self, worksheet):
|
||||
"""Return the index of the worksheet."""
|
||||
return self.worksheets.index(worksheet)
|
||||
|
||||
def get_sheet_names(self):
|
||||
"""Returns the list of the names of worksheets in the workbook.
|
||||
|
||||
Names are returned in the worksheets order.
|
||||
|
||||
:rtype: list of strings
|
||||
|
||||
"""
|
||||
return [s.title for s in self.worksheets]
|
||||
|
||||
def create_named_range(self, name, worksheet, range):
|
||||
"""Create a new named_range on a worksheet"""
|
||||
assert isinstance(worksheet, Worksheet)
|
||||
named_range = NamedRange(name, [(worksheet, range)])
|
||||
self.add_named_range(named_range)
|
||||
|
||||
def get_named_ranges(self):
|
||||
"""Return all named ranges"""
|
||||
return self._named_ranges
|
||||
|
||||
def add_named_range(self, named_range):
|
||||
"""Add an existing named_range to the list of named_ranges."""
|
||||
self._named_ranges.append(named_range)
|
||||
|
||||
def get_named_range(self, name):
|
||||
"""Return the range specified by name."""
|
||||
requested_range = None
|
||||
for named_range in self._named_ranges:
|
||||
if named_range.name == name:
|
||||
requested_range = named_range
|
||||
break
|
||||
return requested_range
|
||||
|
||||
def remove_named_range(self, named_range):
|
||||
"""Remove a named_range from this workbook."""
|
||||
self._named_ranges.remove(named_range)
|
||||
|
||||
def save(self, filename):
|
||||
""" shortcut """
|
||||
if self.__optimized_write:
|
||||
save_dump(self, filename)
|
||||
else:
|
||||
save_workbook(self, filename)
|
||||
@@ -0,0 +1,534 @@
|
||||
# file openpyxl/worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Worksheet is the 2nd-level container in Excel."""
|
||||
|
||||
# Python stdlib imports
|
||||
import re
|
||||
|
||||
# package imports
|
||||
from . import cell
|
||||
from .cell import coordinate_from_string, \
|
||||
column_index_from_string, get_column_letter
|
||||
from .shared.exc import SheetTitleException, \
|
||||
InsufficientCoordinatesException, CellCoordinatesException, \
|
||||
NamedRangeException
|
||||
from .shared.password_hasher import hash_password
|
||||
from .style import Style, DEFAULTS as DEFAULTS_STYLE
|
||||
from .drawing import Drawing
|
||||
|
||||
_DEFAULTS_STYLE_HASH = hash(DEFAULTS_STYLE)
|
||||
|
||||
def flatten(results):
|
||||
|
||||
rows = []
|
||||
|
||||
for row in results:
|
||||
|
||||
cells = []
|
||||
|
||||
for cell in row:
|
||||
|
||||
cells.append(cell.value)
|
||||
|
||||
rows.append(tuple(cells))
|
||||
|
||||
return tuple(rows)
|
||||
|
||||
|
||||
class Relationship(object):
|
||||
"""Represents many kinds of relationships."""
|
||||
# TODO: Use this object for workbook relationships as well as
|
||||
# worksheet relationships
|
||||
TYPES = {
|
||||
'hyperlink': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',
|
||||
'drawing':'http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing',
|
||||
#'worksheet': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet',
|
||||
#'sharedStrings': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings',
|
||||
#'styles': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles',
|
||||
#'theme': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme',
|
||||
}
|
||||
|
||||
def __init__(self, rel_type):
|
||||
if rel_type not in self.TYPES:
|
||||
raise ValueError("Invalid relationship type %s" % rel_type)
|
||||
self.type = self.TYPES[rel_type]
|
||||
self.target = ""
|
||||
self.target_mode = ""
|
||||
self.id = ""
|
||||
|
||||
|
||||
class PageSetup(object):
|
||||
"""Information about page layout for this sheet"""
|
||||
pass
|
||||
|
||||
|
||||
class HeaderFooter(object):
|
||||
"""Information about the header/footer for this sheet."""
|
||||
pass
|
||||
|
||||
|
||||
class SheetView(object):
|
||||
"""Information about the visible portions of this sheet."""
|
||||
pass
|
||||
|
||||
|
||||
class RowDimension(object):
|
||||
"""Information about the display properties of a row."""
|
||||
__slots__ = ('row_index',
|
||||
'height',
|
||||
'visible',
|
||||
'outline_level',
|
||||
'collapsed',
|
||||
'style_index',)
|
||||
|
||||
def __init__(self, index = 0):
|
||||
self.row_index = index
|
||||
self.height = -1
|
||||
self.visible = True
|
||||
self.outline_level = 0
|
||||
self.collapsed = False
|
||||
self.style_index = None
|
||||
|
||||
|
||||
class ColumnDimension(object):
|
||||
"""Information about the display properties of a column."""
|
||||
__slots__ = ('column_index',
|
||||
'width',
|
||||
'auto_size',
|
||||
'visible',
|
||||
'outline_level',
|
||||
'collapsed',
|
||||
'style_index',)
|
||||
|
||||
def __init__(self, index = 'A'):
|
||||
self.column_index = index
|
||||
self.width = -1
|
||||
self.auto_size = False
|
||||
self.visible = True
|
||||
self.outline_level = 0
|
||||
self.collapsed = False
|
||||
self.style_index = 0
|
||||
|
||||
|
||||
class PageMargins(object):
|
||||
"""Information about page margins for view/print layouts."""
|
||||
|
||||
def __init__(self):
|
||||
self.left = self.right = 0.7
|
||||
self.top = self.bottom = 0.75
|
||||
self.header = self.footer = 0.3
|
||||
|
||||
|
||||
class SheetProtection(object):
|
||||
"""Information about protection of various aspects of a sheet."""
|
||||
|
||||
def __init__(self):
|
||||
self.sheet = False
|
||||
self.objects = False
|
||||
self.scenarios = False
|
||||
self.format_cells = False
|
||||
self.format_columns = False
|
||||
self.format_rows = False
|
||||
self.insert_columns = False
|
||||
self.insert_rows = False
|
||||
self.insert_hyperlinks = False
|
||||
self.delete_columns = False
|
||||
self.delete_rows = False
|
||||
self.select_locked_cells = False
|
||||
self.sort = False
|
||||
self.auto_filter = False
|
||||
self.pivot_tables = False
|
||||
self.select_unlocked_cells = False
|
||||
self._password = ''
|
||||
|
||||
def set_password(self, value = '', already_hashed = False):
|
||||
"""Set a password on this sheet."""
|
||||
if not already_hashed:
|
||||
value = hash_password(value)
|
||||
self._password = value
|
||||
|
||||
def _set_raw_password(self, value):
|
||||
"""Set a password directly, forcing a hash step."""
|
||||
self.set_password(value, already_hashed = False)
|
||||
|
||||
def _get_raw_password(self):
|
||||
"""Return the password value, regardless of hash."""
|
||||
return self._password
|
||||
|
||||
password = property(_get_raw_password, _set_raw_password,
|
||||
'get/set the password (if already hashed, '
|
||||
'use set_password() instead)')
|
||||
|
||||
|
||||
class Worksheet(object):
|
||||
"""Represents a worksheet.
|
||||
|
||||
Do not create worksheets yourself,
|
||||
use :func:`openpyxl.workbook.Workbook.create_sheet` instead
|
||||
|
||||
"""
|
||||
BREAK_NONE = 0
|
||||
BREAK_ROW = 1
|
||||
BREAK_COLUMN = 2
|
||||
|
||||
SHEETSTATE_VISIBLE = 'visible'
|
||||
SHEETSTATE_HIDDEN = 'hidden'
|
||||
SHEETSTATE_VERYHIDDEN = 'veryHidden'
|
||||
|
||||
def __init__(self, parent_workbook, title = 'Sheet'):
|
||||
self._parent = parent_workbook
|
||||
self._title = ''
|
||||
if not title:
|
||||
self.title = 'Sheet%d' % (1 + len(self._parent.worksheets))
|
||||
else:
|
||||
self.title = title
|
||||
self.row_dimensions = {}
|
||||
self.column_dimensions = {}
|
||||
self._cells = {}
|
||||
self._styles = {}
|
||||
self._charts = []
|
||||
self.relationships = []
|
||||
self.selected_cell = 'A1'
|
||||
self.active_cell = 'A1'
|
||||
self.sheet_state = self.SHEETSTATE_VISIBLE
|
||||
self.page_setup = PageSetup()
|
||||
self.page_margins = PageMargins()
|
||||
self.header_footer = HeaderFooter()
|
||||
self.sheet_view = SheetView()
|
||||
self.protection = SheetProtection()
|
||||
self.show_gridlines = True
|
||||
self.print_gridlines = False
|
||||
self.show_summary_below = True
|
||||
self.show_summary_right = True
|
||||
self.default_row_dimension = RowDimension()
|
||||
self.default_column_dimension = ColumnDimension()
|
||||
self._auto_filter = None
|
||||
self._freeze_panes = None
|
||||
|
||||
def __repr__(self):
|
||||
return '<Worksheet "%s">' % self.title
|
||||
|
||||
def garbage_collect(self):
|
||||
"""Delete cells that are not storing a value."""
|
||||
delete_list = [coordinate for coordinate, cell in \
|
||||
self._cells.items() if (cell.value in ('', None) and \
|
||||
hash(cell.style) == _DEFAULTS_STYLE_HASH)]
|
||||
for coordinate in delete_list:
|
||||
del self._cells[coordinate]
|
||||
|
||||
def get_cell_collection(self):
|
||||
"""Return an unordered list of the cells in this worksheet."""
|
||||
return self._cells.values()
|
||||
|
||||
def _set_title(self, value):
|
||||
"""Set a sheet title, ensuring it is valid."""
|
||||
bad_title_char_re = re.compile(r'[\\*?:/\[\]]')
|
||||
if bad_title_char_re.search(value):
|
||||
msg = 'Invalid character found in sheet title'
|
||||
raise SheetTitleException(msg)
|
||||
|
||||
# check if sheet_name already exists
|
||||
# do this *before* length check
|
||||
if self._parent.get_sheet_by_name(value):
|
||||
# use name, but append with lowest possible integer
|
||||
i = 1
|
||||
while self._parent.get_sheet_by_name('%s%d' % (value, i)):
|
||||
i += 1
|
||||
value = '%s%d' % (value, i)
|
||||
if len(value) > 31:
|
||||
msg = 'Maximum 31 characters allowed in sheet title'
|
||||
raise SheetTitleException(msg)
|
||||
self._title = value
|
||||
|
||||
def _get_title(self):
|
||||
"""Return the title for this sheet."""
|
||||
return self._title
|
||||
|
||||
title = property(_get_title, _set_title, doc =
|
||||
'Get or set the title of the worksheet. '
|
||||
'Limited to 31 characters, no special characters.')
|
||||
|
||||
def _set_auto_filter(self, range):
|
||||
# Normalize range to a str or None
|
||||
if not range:
|
||||
range = None
|
||||
elif isinstance(range, str):
|
||||
range = range.upper()
|
||||
else: # Assume a range
|
||||
range = range[0][0].address + ':' + range[-1][-1].address
|
||||
self._auto_filter = range
|
||||
|
||||
def _get_auto_filter(self):
|
||||
return self._auto_filter
|
||||
|
||||
auto_filter = property(_get_auto_filter, _set_auto_filter, doc =
|
||||
'get or set auto filtering on columns')
|
||||
def _set_freeze_panes(self, topLeftCell):
|
||||
if not topLeftCell:
|
||||
topLeftCell = None
|
||||
elif isinstance(topLeftCell, str):
|
||||
topLeftCell = topLeftCell.upper()
|
||||
else: # Assume a cell
|
||||
topLeftCell = topLeftCell.address
|
||||
if topLeftCell == 'A1':
|
||||
topLeftCell = None
|
||||
self._freeze_panes = topLeftCell
|
||||
|
||||
def _get_freeze_panes(self):
|
||||
return self._freeze_panes
|
||||
|
||||
freeze_panes = property(_get_freeze_panes,_set_freeze_panes, doc =
|
||||
"Get or set frozen panes")
|
||||
|
||||
def cell(self, coordinate = None, row = None, column = None):
|
||||
"""Returns a cell object based on the given coordinates.
|
||||
|
||||
Usage: cell(coodinate='A15') **or** cell(row=15, column=1)
|
||||
|
||||
If `coordinates` are not given, then row *and* column must be given.
|
||||
|
||||
Cells are kept in a dictionary which is empty at the worksheet
|
||||
creation. Calling `cell` creates the cell in memory when they
|
||||
are first accessed, to reduce memory usage.
|
||||
|
||||
:param coordinate: coordinates of the cell (e.g. 'B12')
|
||||
:type coordinate: string
|
||||
|
||||
:param row: row index of the cell (e.g. 4)
|
||||
:type row: int
|
||||
|
||||
:param column: column index of the cell (e.g. 3)
|
||||
:type column: int
|
||||
|
||||
:raise: InsufficientCoordinatesException when coordinate or (row and column) are not given
|
||||
|
||||
:rtype: :class:`openpyxl.cell.Cell`
|
||||
|
||||
"""
|
||||
if not coordinate:
|
||||
if (row is None or column is None):
|
||||
msg = "You have to provide a value either for " \
|
||||
"'coordinate' or for 'row' *and* 'column'"
|
||||
raise InsufficientCoordinatesException(msg)
|
||||
else:
|
||||
coordinate = '%s%s' % (get_column_letter(column + 1), row + 1)
|
||||
else:
|
||||
coordinate = coordinate.replace('$', '')
|
||||
|
||||
return self._get_cell(coordinate)
|
||||
|
||||
def _get_cell(self, coordinate):
|
||||
|
||||
if not coordinate in self._cells:
|
||||
column, row = coordinate_from_string(coordinate)
|
||||
new_cell = cell.Cell(self, column, row)
|
||||
self._cells[coordinate] = new_cell
|
||||
if column not in self.column_dimensions:
|
||||
self.column_dimensions[column] = ColumnDimension(column)
|
||||
if row not in self.row_dimensions:
|
||||
self.row_dimensions[row] = RowDimension(row)
|
||||
return self._cells[coordinate]
|
||||
|
||||
def get_highest_row(self):
|
||||
"""Returns the maximum row index containing data
|
||||
|
||||
:rtype: int
|
||||
"""
|
||||
if self.row_dimensions:
|
||||
return max(self.row_dimensions.keys())
|
||||
else:
|
||||
return 1
|
||||
|
||||
def get_highest_column(self):
|
||||
"""Get the largest value for column currently stored.
|
||||
|
||||
:rtype: int
|
||||
"""
|
||||
if self.column_dimensions:
|
||||
return max([column_index_from_string(column_index)
|
||||
for column_index in self.column_dimensions])
|
||||
else:
|
||||
return 1
|
||||
|
||||
def calculate_dimension(self):
|
||||
"""Return the minimum bounding range for all cells containing data."""
|
||||
return 'A1:%s%d' % (get_column_letter(self.get_highest_column()),
|
||||
self.get_highest_row())
|
||||
|
||||
def range(self, range_string, row = 0, column = 0):
|
||||
"""Returns a 2D array of cells, with optional row and column offsets.
|
||||
|
||||
:param range_string: cell range string or `named range` name
|
||||
:type range_string: string
|
||||
|
||||
:param row: number of rows to offset
|
||||
:type row: int
|
||||
|
||||
:param column: number of columns to offset
|
||||
:type column: int
|
||||
|
||||
:rtype: tuples of tuples of :class:`openpyxl.cell.Cell`
|
||||
|
||||
"""
|
||||
if ':' in range_string:
|
||||
# R1C1 range
|
||||
result = []
|
||||
min_range, max_range = range_string.split(':')
|
||||
min_col, min_row = coordinate_from_string(min_range)
|
||||
max_col, max_row = coordinate_from_string(max_range)
|
||||
if column:
|
||||
min_col = get_column_letter(
|
||||
column_index_from_string(min_col) + column)
|
||||
max_col = get_column_letter(
|
||||
column_index_from_string(max_col) + column)
|
||||
min_col = column_index_from_string(min_col)
|
||||
max_col = column_index_from_string(max_col)
|
||||
cache_cols = {}
|
||||
for col in xrange(min_col, max_col + 1):
|
||||
cache_cols[col] = get_column_letter(col)
|
||||
rows = xrange(min_row + row, max_row + row + 1)
|
||||
cols = xrange(min_col, max_col + 1)
|
||||
for row in rows:
|
||||
new_row = []
|
||||
for col in cols:
|
||||
new_row.append(self.cell('%s%s' % (cache_cols[col], row)))
|
||||
result.append(tuple(new_row))
|
||||
return tuple(result)
|
||||
else:
|
||||
try:
|
||||
return self.cell(coordinate = range_string, row = row,
|
||||
column = column)
|
||||
except CellCoordinatesException:
|
||||
pass
|
||||
|
||||
# named range
|
||||
named_range = self._parent.get_named_range(range_string)
|
||||
if named_range is None:
|
||||
msg = '%s is not a valid range name' % range_string
|
||||
raise NamedRangeException(msg)
|
||||
|
||||
result = []
|
||||
for destination in named_range.destinations:
|
||||
|
||||
worksheet, cells_range = destination
|
||||
|
||||
if worksheet is not self:
|
||||
msg = 'Range %s is not defined on worksheet %s' % \
|
||||
(cells_range, self.title)
|
||||
raise NamedRangeException(msg)
|
||||
|
||||
content = self.range(cells_range)
|
||||
|
||||
if isinstance(content, tuple):
|
||||
for cells in content:
|
||||
result.extend(cells)
|
||||
else:
|
||||
result.append(content)
|
||||
|
||||
if len(result) == 1:
|
||||
return result[0]
|
||||
else:
|
||||
return tuple(result)
|
||||
|
||||
def get_style(self, coordinate):
|
||||
"""Return the style object for the specified cell."""
|
||||
if not coordinate in self._styles:
|
||||
self._styles[coordinate] = Style()
|
||||
return self._styles[coordinate]
|
||||
|
||||
def create_relationship(self, rel_type):
|
||||
"""Add a relationship for this sheet."""
|
||||
rel = Relationship(rel_type)
|
||||
self.relationships.append(rel)
|
||||
rel_id = self.relationships.index(rel)
|
||||
rel.id = 'rId' + str(rel_id + 1)
|
||||
return self.relationships[rel_id]
|
||||
|
||||
def add_chart(self, chart):
|
||||
""" Add a chart to the sheet """
|
||||
|
||||
chart._sheet = self
|
||||
self._charts.append(chart)
|
||||
|
||||
def append(self, list_or_dict):
|
||||
"""Appends a group of values at the bottom of the current sheet.
|
||||
|
||||
* If it's a list: all values are added in order, starting from the first column
|
||||
* If it's a dict: values are assigned to the columns indicated by the keys (numbers or letters)
|
||||
|
||||
:param list_or_dict: list or dict containing values to append
|
||||
:type list_or_dict: list/tuple or dict
|
||||
|
||||
Usage:
|
||||
|
||||
* append(['This is A1', 'This is B1', 'This is C1'])
|
||||
* **or** append({'A' : 'This is A1', 'C' : 'This is C1'})
|
||||
* **or** append({0 : 'This is A1', 2 : 'This is C1'})
|
||||
|
||||
:raise: TypeError when list_or_dict is neither a list/tuple nor a dict
|
||||
|
||||
"""
|
||||
|
||||
row_idx = len(self.row_dimensions)
|
||||
|
||||
if isinstance(list_or_dict, (list, tuple)):
|
||||
|
||||
for col_idx, content in enumerate(list_or_dict):
|
||||
|
||||
self.cell(row = row_idx, column = col_idx).value = content
|
||||
|
||||
elif isinstance(list_or_dict, dict):
|
||||
|
||||
for col_idx, content in list_or_dict.items():
|
||||
|
||||
if isinstance(col_idx, basestring):
|
||||
col_idx = column_index_from_string(col_idx) - 1
|
||||
|
||||
self.cell(row = row_idx, column = col_idx).value = content
|
||||
|
||||
else:
|
||||
raise TypeError('list_or_dict must be a list or a dict')
|
||||
|
||||
@property
|
||||
def rows(self):
|
||||
|
||||
return self.range(self.calculate_dimension())
|
||||
|
||||
@property
|
||||
def columns(self):
|
||||
|
||||
max_row = self.get_highest_row()
|
||||
|
||||
cols = []
|
||||
|
||||
for col_idx in range(self.get_highest_column()):
|
||||
col = get_column_letter(col_idx+1)
|
||||
res = self.range('%s1:%s%d' % (col, col, max_row))
|
||||
cols.append(tuple([x[0] for x in res]))
|
||||
|
||||
|
||||
return tuple(cols)
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
# file openpyxl/writer/__init__.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Imports for the openpyxl.writer namespace."""
|
||||
|
||||
# package imports
|
||||
from . import excel
|
||||
from . import strings
|
||||
from . import styles
|
||||
from . import theme
|
||||
from . import workbook
|
||||
from . import worksheet
|
||||
@@ -0,0 +1,261 @@
|
||||
# coding=UTF-8
|
||||
'''
|
||||
Copyright (c) 2010 openpyxl
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@license: http://www.opensource.org/licenses/mit-license.php
|
||||
@author: Eric Gazoni
|
||||
'''
|
||||
|
||||
from ..shared.xmltools import Element, SubElement, get_document_content
|
||||
from ..chart import Chart, ErrorBar
|
||||
|
||||
class ChartWriter(object):
|
||||
|
||||
def __init__(self, chart):
|
||||
self.chart = chart
|
||||
|
||||
def write(self):
|
||||
""" write a chart """
|
||||
|
||||
root = Element('c:chartSpace',
|
||||
{'xmlns:c':"http://schemas.openxmlformats.org/drawingml/2006/chart",
|
||||
'xmlns:a':"http://schemas.openxmlformats.org/drawingml/2006/main",
|
||||
'xmlns:r':"http://schemas.openxmlformats.org/officeDocument/2006/relationships"})
|
||||
|
||||
SubElement(root, 'c:lang', {'val':self.chart.lang})
|
||||
self._write_chart(root)
|
||||
self._write_print_settings(root)
|
||||
self._write_shapes(root)
|
||||
|
||||
return get_document_content(root)
|
||||
|
||||
def _write_chart(self, root):
|
||||
|
||||
chart = self.chart
|
||||
|
||||
ch = SubElement(root, 'c:chart')
|
||||
self._write_title(ch)
|
||||
plot_area = SubElement(ch, 'c:plotArea')
|
||||
layout = SubElement(plot_area, 'c:layout')
|
||||
mlayout = SubElement(layout, 'c:manualLayout')
|
||||
SubElement(mlayout, 'c:layoutTarget', {'val':'inner'})
|
||||
SubElement(mlayout, 'c:xMode', {'val':'edge'})
|
||||
SubElement(mlayout, 'c:yMode', {'val':'edge'})
|
||||
SubElement(mlayout, 'c:x', {'val':str(chart._get_margin_left())})
|
||||
SubElement(mlayout, 'c:y', {'val':str(chart._get_margin_top())})
|
||||
SubElement(mlayout, 'c:w', {'val':str(chart.width)})
|
||||
SubElement(mlayout, 'c:h', {'val':str(chart.height)})
|
||||
|
||||
if chart.type == Chart.SCATTER_CHART:
|
||||
subchart = SubElement(plot_area, 'c:scatterChart')
|
||||
SubElement(subchart, 'c:scatterStyle', {'val':str('lineMarker')})
|
||||
else:
|
||||
if chart.type == Chart.BAR_CHART:
|
||||
subchart = SubElement(plot_area, 'c:barChart')
|
||||
SubElement(subchart, 'c:barDir', {'val':'col'})
|
||||
else:
|
||||
subchart = SubElement(plot_area, 'c:lineChart')
|
||||
|
||||
SubElement(subchart, 'c:grouping', {'val':chart.grouping})
|
||||
|
||||
self._write_series(subchart)
|
||||
|
||||
SubElement(subchart, 'c:marker', {'val':'1'})
|
||||
SubElement(subchart, 'c:axId', {'val':str(chart.x_axis.id)})
|
||||
SubElement(subchart, 'c:axId', {'val':str(chart.y_axis.id)})
|
||||
|
||||
if chart.type == Chart.SCATTER_CHART:
|
||||
self._write_axis(plot_area, chart.x_axis, 'c:valAx')
|
||||
else:
|
||||
self._write_axis(plot_area, chart.x_axis, 'c:catAx')
|
||||
self._write_axis(plot_area, chart.y_axis, 'c:valAx')
|
||||
|
||||
self._write_legend(ch)
|
||||
|
||||
SubElement(ch, 'c:plotVisOnly', {'val':'1'})
|
||||
|
||||
def _write_title(self, chart):
|
||||
if self.chart.title != '':
|
||||
title = SubElement(chart, 'c:title')
|
||||
tx = SubElement(title, 'c:tx')
|
||||
rich = SubElement(tx, 'c:rich')
|
||||
SubElement(rich, 'a:bodyPr')
|
||||
SubElement(rich, 'a:lstStyle')
|
||||
p = SubElement(rich, 'a:p')
|
||||
pPr = SubElement(p, 'a:pPr')
|
||||
SubElement(pPr, 'a:defRPr')
|
||||
r = SubElement(p, 'a:r')
|
||||
SubElement(r, 'a:rPr', {'lang':self.chart.lang})
|
||||
t = SubElement(r, 'a:t').text = self.chart.title
|
||||
SubElement(title, 'c:layout')
|
||||
|
||||
def _write_axis(self, plot_area, axis, label):
|
||||
|
||||
ax = SubElement(plot_area, label)
|
||||
SubElement(ax, 'c:axId', {'val':str(axis.id)})
|
||||
|
||||
scaling = SubElement(ax, 'c:scaling')
|
||||
SubElement(scaling, 'c:orientation', {'val':axis.orientation})
|
||||
if label == 'c:valAx':
|
||||
SubElement(scaling, 'c:max', {'val':str(axis.max)})
|
||||
SubElement(scaling, 'c:min', {'val':str(axis.min)})
|
||||
|
||||
SubElement(ax, 'c:axPos', {'val':axis.position})
|
||||
if label == 'c:valAx':
|
||||
SubElement(ax, 'c:majorGridlines')
|
||||
SubElement(ax, 'c:numFmt', {'formatCode':"General", 'sourceLinked':'1'})
|
||||
SubElement(ax, 'c:tickLblPos', {'val':axis.tick_label_position})
|
||||
SubElement(ax, 'c:crossAx', {'val':str(axis.cross)})
|
||||
SubElement(ax, 'c:crosses', {'val':axis.crosses})
|
||||
if axis.auto:
|
||||
SubElement(ax, 'c:auto', {'val':'1'})
|
||||
if axis.label_align:
|
||||
SubElement(ax, 'c:lblAlgn', {'val':axis.label_align})
|
||||
if axis.label_offset:
|
||||
SubElement(ax, 'c:lblOffset', {'val':str(axis.label_offset)})
|
||||
if label == 'c:valAx':
|
||||
if self.chart.type == Chart.SCATTER_CHART:
|
||||
SubElement(ax, 'c:crossBetween', {'val':'midCat'})
|
||||
else:
|
||||
SubElement(ax, 'c:crossBetween', {'val':'between'})
|
||||
SubElement(ax, 'c:majorUnit', {'val':str(axis.unit)})
|
||||
|
||||
def _write_series(self, subchart):
|
||||
|
||||
for i, serie in enumerate(self.chart._series):
|
||||
ser = SubElement(subchart, 'c:ser')
|
||||
SubElement(ser, 'c:idx', {'val':str(i)})
|
||||
SubElement(ser, 'c:order', {'val':str(i)})
|
||||
|
||||
if serie.legend:
|
||||
tx = SubElement(ser, 'c:tx')
|
||||
self._write_serial(tx, serie.legend)
|
||||
|
||||
if serie.color:
|
||||
sppr = SubElement(ser, 'c:spPr')
|
||||
if self.chart.type == Chart.BAR_CHART:
|
||||
# fill color
|
||||
fillc = SubElement(sppr, 'a:solidFill')
|
||||
SubElement(fillc, 'a:srgbClr', {'val':serie.color})
|
||||
# edge color
|
||||
ln = SubElement(sppr, 'a:ln')
|
||||
fill = SubElement(ln, 'a:solidFill')
|
||||
SubElement(fill, 'a:srgbClr', {'val':serie.color})
|
||||
|
||||
if serie.error_bar:
|
||||
self._write_error_bar(ser, serie)
|
||||
|
||||
marker = SubElement(ser, 'c:marker')
|
||||
SubElement(marker, 'c:symbol', {'val':serie.marker})
|
||||
|
||||
if serie.labels:
|
||||
cat = SubElement(ser, 'c:cat')
|
||||
self._write_serial(cat, serie.labels)
|
||||
|
||||
if self.chart.type == Chart.SCATTER_CHART:
|
||||
if serie.xvalues:
|
||||
xval = SubElement(ser, 'c:xVal')
|
||||
self._write_serial(xval, serie.xvalues)
|
||||
|
||||
yval = SubElement(ser, 'c:yVal')
|
||||
self._write_serial(yval, serie.values)
|
||||
else:
|
||||
val = SubElement(ser, 'c:val')
|
||||
self._write_serial(val, serie.values)
|
||||
|
||||
def _write_serial(self, node, serie, literal=False):
|
||||
|
||||
cache = serie._get_cache()
|
||||
if isinstance(cache[0], basestring):
|
||||
typ = 'str'
|
||||
else:
|
||||
typ = 'num'
|
||||
|
||||
if not literal:
|
||||
if typ == 'num':
|
||||
ref = SubElement(node, 'c:numRef')
|
||||
else:
|
||||
ref = SubElement(node, 'c:strRef')
|
||||
SubElement(ref, 'c:f').text = serie._get_ref()
|
||||
if typ == 'num':
|
||||
data = SubElement(ref, 'c:numCache')
|
||||
else:
|
||||
data = SubElement(ref, 'c:strCache')
|
||||
else:
|
||||
data = SubElement(node, 'c:numLit')
|
||||
|
||||
if typ == 'num':
|
||||
SubElement(data, 'c:formatCode').text = 'General'
|
||||
if literal:
|
||||
values = (1,)
|
||||
else:
|
||||
values = cache
|
||||
|
||||
SubElement(data, 'c:ptCount', {'val':str(len(values))})
|
||||
for j, val in enumerate(values):
|
||||
point = SubElement(data, 'c:pt', {'idx':str(j)})
|
||||
SubElement(point, 'c:v').text = str(val)
|
||||
|
||||
def _write_error_bar(self, node, serie):
|
||||
|
||||
flag = {ErrorBar.PLUS_MINUS:'both',
|
||||
ErrorBar.PLUS:'plus',
|
||||
ErrorBar.MINUS:'minus'}
|
||||
|
||||
eb = SubElement(node, 'c:errBars')
|
||||
SubElement(eb, 'c:errBarType', {'val':flag[serie.error_bar.type]})
|
||||
SubElement(eb, 'c:errValType', {'val':'cust'})
|
||||
|
||||
plus = SubElement(eb, 'c:plus')
|
||||
self._write_serial(plus, serie.error_bar.values,
|
||||
literal=(serie.error_bar.type==ErrorBar.MINUS))
|
||||
|
||||
minus = SubElement(eb, 'c:minus')
|
||||
self._write_serial(minus, serie.error_bar.values,
|
||||
literal=(serie.error_bar.type==ErrorBar.PLUS))
|
||||
|
||||
def _write_legend(self, chart):
|
||||
|
||||
legend = SubElement(chart, 'c:legend')
|
||||
SubElement(legend, 'c:legendPos', {'val':self.chart.legend.position})
|
||||
SubElement(legend, 'c:layout')
|
||||
|
||||
def _write_print_settings(self, root):
|
||||
|
||||
settings = SubElement(root, 'c:printSettings')
|
||||
SubElement(settings, 'c:headerFooter')
|
||||
margins = dict([(k, str(v)) for (k,v) in self.chart.print_margins.items()])
|
||||
SubElement(settings, 'c:pageMargins', margins)
|
||||
SubElement(settings, 'c:pageSetup')
|
||||
|
||||
def _write_shapes(self, root):
|
||||
|
||||
if self.chart._shapes:
|
||||
SubElement(root, 'c:userShapes', {'r:id':'rId1'})
|
||||
|
||||
def write_rels(self, drawing_id):
|
||||
|
||||
root = Element('Relationships', {'xmlns' : 'http://schemas.openxmlformats.org/package/2006/relationships'})
|
||||
attrs = {'Id' : 'rId1',
|
||||
'Type' : 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chartUserShapes',
|
||||
'Target' : '../drawings/drawing%s.xml' % drawing_id }
|
||||
SubElement(root, 'Relationship', attrs)
|
||||
return get_document_content(root)
|
||||
@@ -0,0 +1,192 @@
|
||||
# coding=UTF-8
|
||||
'''
|
||||
Copyright (c) 2010 openpyxl
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@license: http://www.opensource.org/licenses/mit-license.php
|
||||
@author: Eric Gazoni
|
||||
'''
|
||||
|
||||
from ..shared.xmltools import Element, SubElement, get_document_content
|
||||
|
||||
|
||||
class DrawingWriter(object):
|
||||
""" one main drawing file per sheet """
|
||||
|
||||
def __init__(self, sheet):
|
||||
self._sheet = sheet
|
||||
|
||||
def write(self):
|
||||
""" write drawings for one sheet in one file """
|
||||
|
||||
root = Element('xdr:wsDr',
|
||||
{'xmlns:xdr' : "http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing",
|
||||
'xmlns:a' : "http://schemas.openxmlformats.org/drawingml/2006/main"})
|
||||
|
||||
for i, chart in enumerate(self._sheet._charts):
|
||||
|
||||
drawing = chart.drawing
|
||||
|
||||
# anchor = SubElement(root, 'xdr:twoCellAnchor')
|
||||
# (start_row, start_col), (end_row, end_col) = drawing.coordinates
|
||||
# # anchor coordinates
|
||||
# _from = SubElement(anchor, 'xdr:from')
|
||||
# x = SubElement(_from, 'xdr:col').text = str(start_col)
|
||||
# x = SubElement(_from, 'xdr:colOff').text = '0'
|
||||
# x = SubElement(_from, 'xdr:row').text = str(start_row)
|
||||
# x = SubElement(_from, 'xdr:rowOff').text = '0'
|
||||
|
||||
# _to = SubElement(anchor, 'xdr:to')
|
||||
# x = SubElement(_to, 'xdr:col').text = str(end_col)
|
||||
# x = SubElement(_to, 'xdr:colOff').text = '0'
|
||||
# x = SubElement(_to, 'xdr:row').text = str(end_row)
|
||||
# x = SubElement(_to, 'xdr:rowOff').text = '0'
|
||||
|
||||
# we only support absolute anchor atm (TODO: oneCellAnchor, twoCellAnchor
|
||||
x, y, w, h = drawing.get_emu_dimensions()
|
||||
anchor = SubElement(root, 'xdr:absoluteAnchor')
|
||||
SubElement(anchor, 'xdr:pos', {'x':str(x), 'y':str(y)})
|
||||
SubElement(anchor, 'xdr:ext', {'cx':str(w), 'cy':str(h)})
|
||||
|
||||
# graph frame
|
||||
frame = SubElement(anchor, 'xdr:graphicFrame', {'macro':''})
|
||||
|
||||
name = SubElement(frame, 'xdr:nvGraphicFramePr')
|
||||
SubElement(name, 'xdr:cNvPr', {'id':'%s' % i, 'name':'Graphique %s' % i})
|
||||
SubElement(name, 'xdr:cNvGraphicFramePr')
|
||||
|
||||
frm = SubElement(frame, 'xdr:xfrm')
|
||||
# no transformation
|
||||
SubElement(frm, 'a:off', {'x':'0', 'y':'0'})
|
||||
SubElement(frm, 'a:ext', {'cx':'0', 'cy':'0'})
|
||||
|
||||
graph = SubElement(frame, 'a:graphic')
|
||||
data = SubElement(graph, 'a:graphicData',
|
||||
{'uri':'http://schemas.openxmlformats.org/drawingml/2006/chart'})
|
||||
SubElement(data, 'c:chart',
|
||||
{ 'xmlns:c':'http://schemas.openxmlformats.org/drawingml/2006/chart',
|
||||
'xmlns:r':'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
|
||||
'r:id':'rId%s' % (i + 1)})
|
||||
|
||||
SubElement(anchor, 'xdr:clientData')
|
||||
|
||||
return get_document_content(root)
|
||||
|
||||
def write_rels(self, chart_id):
|
||||
|
||||
root = Element('Relationships',
|
||||
{'xmlns' : 'http://schemas.openxmlformats.org/package/2006/relationships'})
|
||||
for i, chart in enumerate(self._sheet._charts):
|
||||
attrs = {'Id' : 'rId%s' % (i + 1),
|
||||
'Type' : 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart',
|
||||
'Target' : '../charts/chart%s.xml' % (chart_id + i) }
|
||||
SubElement(root, 'Relationship', attrs)
|
||||
return get_document_content(root)
|
||||
|
||||
class ShapeWriter(object):
|
||||
""" one file per shape """
|
||||
|
||||
schema = "http://schemas.openxmlformats.org/drawingml/2006/main"
|
||||
|
||||
def __init__(self, shapes):
|
||||
|
||||
self._shapes = shapes
|
||||
|
||||
def write(self, shape_id):
|
||||
|
||||
root = Element('c:userShapes', {'xmlns:c' : 'http://schemas.openxmlformats.org/drawingml/2006/chart'})
|
||||
|
||||
for shape in self._shapes:
|
||||
anchor = SubElement(root, 'cdr:relSizeAnchor',
|
||||
{'xmlns:cdr' : "http://schemas.openxmlformats.org/drawingml/2006/chartDrawing"})
|
||||
|
||||
xstart, ystart, xend, yend = shape.get_coordinates()
|
||||
|
||||
_from = SubElement(anchor, 'cdr:from')
|
||||
SubElement(_from, 'cdr:x').text = str(xstart)
|
||||
SubElement(_from, 'cdr:y').text = str(ystart)
|
||||
|
||||
_to = SubElement(anchor, 'cdr:to')
|
||||
SubElement(_to, 'cdr:x').text = str(xend)
|
||||
SubElement(_to, 'cdr:y').text = str(yend)
|
||||
|
||||
sp = SubElement(anchor, 'cdr:sp', {'macro':'', 'textlink':''})
|
||||
nvspr = SubElement(sp, 'cdr:nvSpPr')
|
||||
SubElement(nvspr, 'cdr:cNvPr', {'id':str(shape_id), 'name':'shape %s' % shape_id})
|
||||
SubElement(nvspr, 'cdr:cNvSpPr')
|
||||
|
||||
sppr = SubElement(sp, 'cdr:spPr')
|
||||
frm = SubElement(sppr, 'a:xfrm', {'xmlns:a':self.schema})
|
||||
# no transformation
|
||||
SubElement(frm, 'a:off', {'x':'0', 'y':'0'})
|
||||
SubElement(frm, 'a:ext', {'cx':'0', 'cy':'0'})
|
||||
|
||||
prstgeom = SubElement(sppr, 'a:prstGeom', {'xmlns:a':self.schema, 'prst':str(shape.style)})
|
||||
SubElement(prstgeom, 'a:avLst')
|
||||
|
||||
fill = SubElement(sppr, 'a:solidFill', {'xmlns:a':self.schema})
|
||||
SubElement(fill, 'a:srgbClr', {'val':shape.color})
|
||||
|
||||
border = SubElement(sppr, 'a:ln', {'xmlns:a':self.schema, 'w':str(shape._border_width)})
|
||||
sf = SubElement(border, 'a:solidFill')
|
||||
SubElement(sf, 'a:srgbClr', {'val':shape.border_color})
|
||||
|
||||
self._write_style(sp)
|
||||
self._write_text(sp, shape)
|
||||
|
||||
shape_id += 1
|
||||
|
||||
return get_document_content(root)
|
||||
|
||||
def _write_text(self, node, shape):
|
||||
""" write text in the shape """
|
||||
|
||||
tx_body = SubElement(node, 'cdr:txBody')
|
||||
SubElement(tx_body, 'a:bodyPr', {'xmlns:a':self.schema, 'vertOverflow':'clip'})
|
||||
SubElement(tx_body, 'a:lstStyle',
|
||||
{'xmlns:a':self.schema})
|
||||
p = SubElement(tx_body, 'a:p', {'xmlns:a':self.schema})
|
||||
if shape.text:
|
||||
r = SubElement(p, 'a:r')
|
||||
rpr = SubElement(r, 'a:rPr', {'lang':'en-US'})
|
||||
fill = SubElement(rpr, 'a:solidFill')
|
||||
SubElement(fill, 'a:srgbClr', {'val':shape.text_color})
|
||||
|
||||
SubElement(r, 'a:t').text = shape.text
|
||||
else:
|
||||
SubElement(p, 'a:endParaRPr', {'lang':'en-US'})
|
||||
|
||||
def _write_style(self, node):
|
||||
""" write style theme """
|
||||
|
||||
style = SubElement(node, 'cdr:style')
|
||||
|
||||
ln_ref = SubElement(style, 'a:lnRef', {'xmlns:a':self.schema, 'idx':'2'})
|
||||
scheme_clr = SubElement(ln_ref, 'a:schemeClr', {'val':'accent1'})
|
||||
SubElement(scheme_clr, 'a:shade', {'val':'50000'})
|
||||
|
||||
fill_ref = SubElement(style, 'a:fillRef', {'xmlns:a':self.schema, 'idx':'1'})
|
||||
SubElement(fill_ref, 'a:schemeClr', {'val':'accent1'})
|
||||
|
||||
effect_ref = SubElement(style, 'a:effectRef', {'xmlns:a':self.schema, 'idx':'0'})
|
||||
SubElement(effect_ref, 'a:schemeClr', {'val':'accent1'})
|
||||
|
||||
font_ref = SubElement(style, 'a:fontRef', {'xmlns:a':self.schema, 'idx':'minor'})
|
||||
SubElement(font_ref, 'a:schemeClr', {'val':'lt1'})
|
||||
@@ -0,0 +1,256 @@
|
||||
# file openpyxl/writer/straight_worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write worksheets to xml representations in an optimized way"""
|
||||
|
||||
import datetime
|
||||
import os
|
||||
|
||||
from ..cell import column_index_from_string, get_column_letter, Cell
|
||||
from ..worksheet import Worksheet
|
||||
from ..shared.xmltools import XMLGenerator, get_document_content, \
|
||||
start_tag, end_tag, tag
|
||||
from ..shared.date_time import SharedDate
|
||||
from ..shared.ooxml import MAX_COLUMN, MAX_ROW
|
||||
from tempfile import NamedTemporaryFile
|
||||
from ..writer.excel import ExcelWriter
|
||||
from ..writer.strings import write_string_table
|
||||
from ..writer.styles import StyleWriter
|
||||
from ..style import Style, NumberFormat
|
||||
|
||||
from ..shared.ooxml import ARC_SHARED_STRINGS, ARC_CONTENT_TYPES, \
|
||||
ARC_ROOT_RELS, ARC_WORKBOOK_RELS, ARC_APP, ARC_CORE, ARC_THEME, \
|
||||
ARC_STYLE, ARC_WORKBOOK, \
|
||||
PACKAGE_WORKSHEETS, PACKAGE_DRAWINGS, PACKAGE_CHARTS
|
||||
|
||||
STYLES = {'datetime' : {'type':Cell.TYPE_NUMERIC,
|
||||
'style':'1'},
|
||||
'string':{'type':Cell.TYPE_STRING,
|
||||
'style':'0'},
|
||||
'numeric':{'type':Cell.TYPE_NUMERIC,
|
||||
'style':'0'},
|
||||
'formula':{'type':Cell.TYPE_FORMULA,
|
||||
'style':'0'},
|
||||
'boolean':{'type':Cell.TYPE_BOOL,
|
||||
'style':'0'},
|
||||
}
|
||||
|
||||
DATETIME_STYLE = Style()
|
||||
DATETIME_STYLE.number_format.format_code = NumberFormat.FORMAT_DATE_YYYYMMDD2
|
||||
BOUNDING_BOX_PLACEHOLDER = 'A1:%s%d' % (get_column_letter(MAX_COLUMN), MAX_ROW)
|
||||
|
||||
class DumpWorksheet(Worksheet):
|
||||
|
||||
"""
|
||||
.. warning::
|
||||
|
||||
You shouldn't initialize this yourself, use :class:`openpyxl.workbook.Workbook` constructor instead,
|
||||
with `optimized_write = True`.
|
||||
"""
|
||||
|
||||
def __init__(self, parent_workbook):
|
||||
|
||||
Worksheet.__init__(self, parent_workbook)
|
||||
|
||||
self._max_col = 0
|
||||
self._max_row = 0
|
||||
self._parent = parent_workbook
|
||||
self._fileobj_header = NamedTemporaryFile(mode='r+', prefix='openpyxl.', suffix='.header', delete=False)
|
||||
self._fileobj_content = NamedTemporaryFile(mode='r+', prefix='openpyxl.', suffix='.content', delete=False)
|
||||
self._fileobj = NamedTemporaryFile(mode='w', prefix='openpyxl.', delete=False)
|
||||
self.doc = XMLGenerator(self._fileobj_content, 'utf-8')
|
||||
self.header = XMLGenerator(self._fileobj_header, 'utf-8')
|
||||
self.title = 'Sheet'
|
||||
|
||||
self._shared_date = SharedDate()
|
||||
self._string_builder = self._parent.strings_table_builder
|
||||
|
||||
@property
|
||||
def filename(self):
|
||||
return self._fileobj.name
|
||||
|
||||
def write_header(self):
|
||||
|
||||
doc = self.header
|
||||
|
||||
start_tag(doc, 'worksheet',
|
||||
{'xml:space': 'preserve',
|
||||
'xmlns': 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
|
||||
'xmlns:r': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'})
|
||||
start_tag(doc, 'sheetPr')
|
||||
tag(doc, 'outlinePr',
|
||||
{'summaryBelow': '1',
|
||||
'summaryRight': '1'})
|
||||
end_tag(doc, 'sheetPr')
|
||||
tag(doc, 'dimension', {'ref': 'A1:%s' % (self.get_dimensions())})
|
||||
start_tag(doc, 'sheetViews')
|
||||
start_tag(doc, 'sheetView', {'workbookViewId': '0'})
|
||||
tag(doc, 'selection', {'activeCell': 'A1',
|
||||
'sqref': 'A1'})
|
||||
end_tag(doc, 'sheetView')
|
||||
end_tag(doc, 'sheetViews')
|
||||
tag(doc, 'sheetFormatPr', {'defaultRowHeight': '15'})
|
||||
start_tag(doc, 'sheetData')
|
||||
|
||||
def close(self):
|
||||
|
||||
self._close_content()
|
||||
self._close_header()
|
||||
|
||||
self._write_fileobj(self._fileobj_header)
|
||||
self._write_fileobj(self._fileobj_content)
|
||||
|
||||
self._fileobj.close()
|
||||
|
||||
def _write_fileobj(self, fobj):
|
||||
|
||||
fobj.flush()
|
||||
fobj.seek(0)
|
||||
|
||||
while True:
|
||||
chunk = fobj.read(4096)
|
||||
if not chunk:
|
||||
break
|
||||
self._fileobj.write(chunk)
|
||||
|
||||
fobj.close()
|
||||
os.remove(fobj.name)
|
||||
|
||||
self._fileobj.flush()
|
||||
|
||||
def _close_header(self):
|
||||
|
||||
doc = self.header
|
||||
#doc.endDocument()
|
||||
|
||||
def _close_content(self):
|
||||
|
||||
doc = self.doc
|
||||
end_tag(doc, 'sheetData')
|
||||
|
||||
end_tag(doc, 'worksheet')
|
||||
#doc.endDocument()
|
||||
|
||||
def get_dimensions(self):
|
||||
|
||||
if not self._max_col or not self._max_row:
|
||||
return 'A1'
|
||||
else:
|
||||
return '%s%d' % (get_column_letter(self._max_col), (self._max_row))
|
||||
|
||||
def append(self, row):
|
||||
|
||||
"""
|
||||
:param row: iterable containing values to append
|
||||
:type row: iterable
|
||||
"""
|
||||
|
||||
doc = self.doc
|
||||
|
||||
self._max_row += 1
|
||||
span = len(row)
|
||||
self._max_col = max(self._max_col, span)
|
||||
|
||||
row_idx = self._max_row
|
||||
|
||||
attrs = {'r': '%d' % row_idx,
|
||||
'spans': '1:%d' % span}
|
||||
|
||||
start_tag(doc, 'row', attrs)
|
||||
|
||||
for col_idx, cell in enumerate(row):
|
||||
|
||||
if cell is None:
|
||||
continue
|
||||
|
||||
coordinate = '%s%d' % (get_column_letter(col_idx+1), row_idx)
|
||||
attributes = {'r': coordinate}
|
||||
|
||||
if isinstance(cell, bool):
|
||||
dtype = 'boolean'
|
||||
elif isinstance(cell, (int, float)):
|
||||
dtype = 'numeric'
|
||||
elif isinstance(cell, (datetime.datetime, datetime.date)):
|
||||
dtype = 'datetime'
|
||||
cell = self._shared_date.datetime_to_julian(cell)
|
||||
attributes['s'] = STYLES[dtype]['style']
|
||||
elif cell and cell[0] == '=':
|
||||
dtype = 'formula'
|
||||
else:
|
||||
dtype = 'string'
|
||||
cell = self._string_builder.add(cell)
|
||||
|
||||
attributes['t'] = STYLES[dtype]['type']
|
||||
|
||||
start_tag(doc, 'c', attributes)
|
||||
|
||||
if dtype == 'formula':
|
||||
tag(doc, 'f', body = '%s' % cell[1:])
|
||||
tag(doc, 'v')
|
||||
else:
|
||||
tag(doc, 'v', body = '%s' % cell)
|
||||
|
||||
end_tag(doc, 'c')
|
||||
|
||||
|
||||
end_tag(doc, 'row')
|
||||
|
||||
|
||||
def save_dump(workbook, filename):
|
||||
|
||||
writer = ExcelDumpWriter(workbook)
|
||||
writer.save(filename)
|
||||
return True
|
||||
|
||||
class ExcelDumpWriter(ExcelWriter):
|
||||
|
||||
def __init__(self, workbook):
|
||||
|
||||
self.workbook = workbook
|
||||
self.style_writer = StyleDumpWriter(workbook)
|
||||
self.style_writer._style_list.append(DATETIME_STYLE)
|
||||
|
||||
def _write_string_table(self, archive):
|
||||
|
||||
shared_string_table = self.workbook.strings_table_builder.get_table()
|
||||
archive.writestr(ARC_SHARED_STRINGS,
|
||||
write_string_table(shared_string_table))
|
||||
|
||||
return shared_string_table
|
||||
|
||||
def _write_worksheets(self, archive, shared_string_table, style_writer):
|
||||
|
||||
for i, sheet in enumerate(self.workbook.worksheets):
|
||||
sheet.write_header()
|
||||
sheet.close()
|
||||
archive.write(sheet.filename, PACKAGE_WORKSHEETS + '/sheet%d.xml' % (i + 1))
|
||||
os.remove(sheet.filename)
|
||||
|
||||
|
||||
class StyleDumpWriter(StyleWriter):
|
||||
|
||||
def _get_style_list(self, workbook):
|
||||
return []
|
||||
|
||||
@@ -0,0 +1,161 @@
|
||||
# file openpyxl/writer/excel.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write a .xlsx file."""
|
||||
|
||||
# Python stdlib imports
|
||||
from zipfile import ZipFile, ZIP_DEFLATED
|
||||
from ....compat import BytesIO as StringIO
|
||||
|
||||
# package imports
|
||||
from ..shared.ooxml import ARC_SHARED_STRINGS, ARC_CONTENT_TYPES, \
|
||||
ARC_ROOT_RELS, ARC_WORKBOOK_RELS, ARC_APP, ARC_CORE, ARC_THEME, \
|
||||
ARC_STYLE, ARC_WORKBOOK, \
|
||||
PACKAGE_WORKSHEETS, PACKAGE_DRAWINGS, PACKAGE_CHARTS
|
||||
from ..writer.strings import create_string_table, write_string_table
|
||||
from ..writer.workbook import write_content_types, write_root_rels, \
|
||||
write_workbook_rels, write_properties_app, write_properties_core, \
|
||||
write_workbook
|
||||
from ..writer.theme import write_theme
|
||||
from ..writer.styles import StyleWriter
|
||||
from ..writer.drawings import DrawingWriter, ShapeWriter
|
||||
from ..writer.charts import ChartWriter
|
||||
from ..writer.worksheet import write_worksheet, write_worksheet_rels
|
||||
|
||||
|
||||
class ExcelWriter(object):
|
||||
"""Write a workbook object to an Excel file."""
|
||||
|
||||
def __init__(self, workbook):
|
||||
self.workbook = workbook
|
||||
self.style_writer = StyleWriter(self.workbook)
|
||||
|
||||
def write_data(self, archive):
|
||||
"""Write the various xml files into the zip archive."""
|
||||
# cleanup all worksheets
|
||||
shared_string_table = self._write_string_table(archive)
|
||||
|
||||
archive.writestr(ARC_CONTENT_TYPES, write_content_types(self.workbook))
|
||||
archive.writestr(ARC_ROOT_RELS, write_root_rels(self.workbook))
|
||||
archive.writestr(ARC_WORKBOOK_RELS, write_workbook_rels(self.workbook))
|
||||
archive.writestr(ARC_APP, write_properties_app(self.workbook))
|
||||
archive.writestr(ARC_CORE,
|
||||
write_properties_core(self.workbook.properties))
|
||||
archive.writestr(ARC_THEME, write_theme())
|
||||
archive.writestr(ARC_STYLE, self.style_writer.write_table())
|
||||
archive.writestr(ARC_WORKBOOK, write_workbook(self.workbook))
|
||||
|
||||
self._write_worksheets(archive, shared_string_table, self.style_writer)
|
||||
|
||||
def _write_string_table(self, archive):
|
||||
|
||||
for ws in self.workbook.worksheets:
|
||||
ws.garbage_collect()
|
||||
shared_string_table = create_string_table(self.workbook)
|
||||
|
||||
|
||||
archive.writestr(ARC_SHARED_STRINGS,
|
||||
write_string_table(shared_string_table))
|
||||
|
||||
for k, v in shared_string_table.items():
|
||||
shared_string_table[k] = bytes(v)
|
||||
|
||||
return shared_string_table
|
||||
|
||||
def _write_worksheets(self, archive, shared_string_table, style_writer):
|
||||
|
||||
drawing_id = 1
|
||||
chart_id = 1
|
||||
shape_id = 1
|
||||
|
||||
for i, sheet in enumerate(self.workbook.worksheets):
|
||||
archive.writestr(PACKAGE_WORKSHEETS + '/sheet%d.xml' % (i + 1),
|
||||
write_worksheet(sheet, shared_string_table,
|
||||
style_writer.get_style_by_hash()))
|
||||
if sheet._charts or sheet.relationships:
|
||||
archive.writestr(PACKAGE_WORKSHEETS +
|
||||
'/_rels/sheet%d.xml.rels' % (i + 1),
|
||||
write_worksheet_rels(sheet, drawing_id))
|
||||
if sheet._charts:
|
||||
dw = DrawingWriter(sheet)
|
||||
archive.writestr(PACKAGE_DRAWINGS + '/drawing%d.xml' % drawing_id,
|
||||
dw.write())
|
||||
archive.writestr(PACKAGE_DRAWINGS + '/_rels/drawing%d.xml.rels' % drawing_id,
|
||||
dw.write_rels(chart_id))
|
||||
drawing_id += 1
|
||||
|
||||
for chart in sheet._charts:
|
||||
cw = ChartWriter(chart)
|
||||
archive.writestr(PACKAGE_CHARTS + '/chart%d.xml' % chart_id,
|
||||
cw.write())
|
||||
|
||||
if chart._shapes:
|
||||
archive.writestr(PACKAGE_CHARTS + '/_rels/chart%d.xml.rels' % chart_id,
|
||||
cw.write_rels(drawing_id))
|
||||
sw = ShapeWriter(chart._shapes)
|
||||
archive.writestr(PACKAGE_DRAWINGS + '/drawing%d.xml' % drawing_id,
|
||||
sw.write(shape_id))
|
||||
shape_id += len(chart._shapes)
|
||||
drawing_id += 1
|
||||
|
||||
chart_id += 1
|
||||
|
||||
|
||||
def save(self, filename):
|
||||
"""Write data into the archive."""
|
||||
archive = ZipFile(filename, 'w', ZIP_DEFLATED)
|
||||
self.write_data(archive)
|
||||
archive.close()
|
||||
|
||||
|
||||
def save_workbook(workbook, filename):
|
||||
"""Save the given workbook on the filesystem under the name filename.
|
||||
|
||||
:param workbook: the workbook to save
|
||||
:type workbook: :class:`openpyxl.workbook.Workbook`
|
||||
|
||||
:param filename: the path to which save the workbook
|
||||
:type filename: string
|
||||
|
||||
:rtype: bool
|
||||
|
||||
"""
|
||||
writer = ExcelWriter(workbook)
|
||||
writer.save(filename)
|
||||
return True
|
||||
|
||||
|
||||
def save_virtual_workbook(workbook):
|
||||
"""Return an in-memory workbook, suitable for a Django response."""
|
||||
writer = ExcelWriter(workbook)
|
||||
temp_buffer = StringIO()
|
||||
try:
|
||||
archive = ZipFile(temp_buffer, 'w', ZIP_DEFLATED)
|
||||
writer.write_data(archive)
|
||||
finally:
|
||||
archive.close()
|
||||
virtual_workbook = temp_buffer.getvalue()
|
||||
temp_buffer.close()
|
||||
return virtual_workbook
|
||||
@@ -0,0 +1,86 @@
|
||||
# file openpyxl/writer/strings.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write the shared string table."""
|
||||
|
||||
# Python stdlib imports
|
||||
from ....compat import BytesIO as StringIO
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import start_tag, end_tag, tag, XMLGenerator
|
||||
|
||||
|
||||
def create_string_table(workbook):
|
||||
"""Compile the string table for a workbook."""
|
||||
strings = set()
|
||||
for sheet in workbook.worksheets:
|
||||
for cell in sheet.get_cell_collection():
|
||||
if cell.data_type == cell.TYPE_STRING and cell._value is not None:
|
||||
strings.add(cell.value)
|
||||
return dict((key, i) for i, key in enumerate(strings))
|
||||
|
||||
|
||||
def write_string_table(string_table):
|
||||
"""Write the string table xml."""
|
||||
temp_buffer = StringIO()
|
||||
doc = XMLGenerator(temp_buffer, 'utf-8')
|
||||
start_tag(doc, 'sst', {'xmlns':
|
||||
'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
|
||||
'uniqueCount': '%d' % len(string_table)})
|
||||
strings_to_write = sorted(string_table.items(),
|
||||
key=lambda pair: pair[1])
|
||||
for key in [pair[0] for pair in strings_to_write]:
|
||||
start_tag(doc, 'si')
|
||||
if key.strip() != key:
|
||||
attr = {'xml:space': 'preserve'}
|
||||
else:
|
||||
attr = {}
|
||||
tag(doc, 't', attr, key)
|
||||
end_tag(doc, 'si')
|
||||
end_tag(doc, 'sst')
|
||||
string_table_xml = temp_buffer.getvalue()
|
||||
temp_buffer.close()
|
||||
return string_table_xml
|
||||
|
||||
class StringTableBuilder(object):
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.counter = 0
|
||||
self.dct = {}
|
||||
|
||||
def add(self, key):
|
||||
|
||||
key = key.strip()
|
||||
try:
|
||||
return self.dct[key]
|
||||
except KeyError:
|
||||
res = self.dct[key] = self.counter
|
||||
self.counter += 1
|
||||
return res
|
||||
|
||||
def get_table(self):
|
||||
|
||||
return self.dct
|
||||
@@ -0,0 +1,256 @@
|
||||
# file openpyxl/writer/styles.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write the shared style table."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import Element, SubElement
|
||||
from ..shared.xmltools import get_document_content
|
||||
from .. import style
|
||||
|
||||
class StyleWriter(object):
|
||||
|
||||
def __init__(self, workbook):
|
||||
self._style_list = self._get_style_list(workbook)
|
||||
self._root = Element('styleSheet',
|
||||
{'xmlns':'http://schemas.openxmlformats.org/spreadsheetml/2006/main'})
|
||||
|
||||
def _get_style_list(self, workbook):
|
||||
crc = {}
|
||||
for worksheet in workbook.worksheets:
|
||||
for style in worksheet._styles.values():
|
||||
crc[hash(style)] = style
|
||||
self.style_table = dict([(style, i+1) \
|
||||
for i, style in enumerate(crc.values())])
|
||||
sorted_styles = sorted(self.style_table.items(), \
|
||||
key = lambda pair:pair[1])
|
||||
return [s[0] for s in sorted_styles]
|
||||
|
||||
def get_style_by_hash(self):
|
||||
return dict([(hash(style), id) \
|
||||
for style, id in self.style_table.items()])
|
||||
|
||||
def write_table(self):
|
||||
number_format_table = self._write_number_formats()
|
||||
fonts_table = self._write_fonts()
|
||||
fills_table = self._write_fills()
|
||||
borders_table = self._write_borders()
|
||||
self._write_cell_style_xfs()
|
||||
self._write_cell_xfs(number_format_table, fonts_table, fills_table, borders_table)
|
||||
self._write_cell_style()
|
||||
self._write_dxfs()
|
||||
self._write_table_styles()
|
||||
|
||||
return get_document_content(xml_node=self._root)
|
||||
|
||||
def _write_fonts(self):
|
||||
""" add fonts part to root
|
||||
return {font.crc => index}
|
||||
"""
|
||||
|
||||
fonts = SubElement(self._root, 'fonts')
|
||||
|
||||
# default
|
||||
font_node = SubElement(fonts, 'font')
|
||||
SubElement(font_node, 'sz', {'val':'11'})
|
||||
SubElement(font_node, 'color', {'theme':'1'})
|
||||
SubElement(font_node, 'name', {'val':'Calibri'})
|
||||
SubElement(font_node, 'family', {'val':'2'})
|
||||
SubElement(font_node, 'scheme', {'val':'minor'})
|
||||
|
||||
# others
|
||||
table = {}
|
||||
index = 1
|
||||
for st in self._style_list:
|
||||
if hash(st.font) != hash(style.DEFAULTS.font) and hash(st.font) not in table:
|
||||
table[hash(st.font)] = str(index)
|
||||
font_node = SubElement(fonts, 'font')
|
||||
SubElement(font_node, 'sz', {'val':str(st.font.size)})
|
||||
SubElement(font_node, 'color', {'rgb':str(st.font.color.index)})
|
||||
SubElement(font_node, 'name', {'val':st.font.name})
|
||||
SubElement(font_node, 'family', {'val':'2'})
|
||||
SubElement(font_node, 'scheme', {'val':'minor'})
|
||||
if st.font.bold:
|
||||
SubElement(font_node, 'b')
|
||||
if st.font.italic:
|
||||
SubElement(font_node, 'i')
|
||||
index += 1
|
||||
|
||||
fonts.attrib["count"] = str(index)
|
||||
return table
|
||||
|
||||
def _write_fills(self):
|
||||
fills = SubElement(self._root, 'fills', {'count':'2'})
|
||||
fill = SubElement(fills, 'fill')
|
||||
SubElement(fill, 'patternFill', {'patternType':'none'})
|
||||
fill = SubElement(fills, 'fill')
|
||||
SubElement(fill, 'patternFill', {'patternType':'gray125'})
|
||||
|
||||
table = {}
|
||||
index = 2
|
||||
for st in self._style_list:
|
||||
if hash(st.fill) != hash(style.DEFAULTS.fill) and hash(st.fill) not in table:
|
||||
table[hash(st.fill)] = str(index)
|
||||
fill = SubElement(fills, 'fill')
|
||||
if hash(st.fill.fill_type) != hash(style.DEFAULTS.fill.fill_type):
|
||||
node = SubElement(fill,'patternFill', {'patternType':st.fill.fill_type})
|
||||
if hash(st.fill.start_color) != hash(style.DEFAULTS.fill.start_color):
|
||||
|
||||
SubElement(node, 'fgColor', {'rgb':str(st.fill.start_color.index)})
|
||||
if hash(st.fill.end_color) != hash(style.DEFAULTS.fill.end_color):
|
||||
SubElement(node, 'bgColor', {'rgb':str(st.fill.start_color.index)})
|
||||
index += 1
|
||||
|
||||
fills.attrib["count"] = str(index)
|
||||
return table
|
||||
|
||||
def _write_borders(self):
|
||||
borders = SubElement(self._root, 'borders')
|
||||
|
||||
# default
|
||||
border = SubElement(borders, 'border')
|
||||
SubElement(border, 'left')
|
||||
SubElement(border, 'right')
|
||||
SubElement(border, 'top')
|
||||
SubElement(border, 'bottom')
|
||||
SubElement(border, 'diagonal')
|
||||
|
||||
# others
|
||||
table = {}
|
||||
index = 1
|
||||
for st in self._style_list:
|
||||
if hash(st.borders) != hash(style.DEFAULTS.borders) and hash(st.borders) not in table:
|
||||
table[hash(st.borders)] = str(index)
|
||||
border = SubElement(borders, 'border')
|
||||
# caution: respect this order
|
||||
for side in ('left','right','top','bottom','diagonal'):
|
||||
obj = getattr(st.borders, side)
|
||||
node = SubElement(border, side, {'style':obj.border_style})
|
||||
SubElement(node, 'color', {'rgb':str(obj.color.index)})
|
||||
index += 1
|
||||
|
||||
borders.attrib["count"] = str(index)
|
||||
return table
|
||||
|
||||
def _write_cell_style_xfs(self):
|
||||
cell_style_xfs = SubElement(self._root, 'cellStyleXfs', {'count':'1'})
|
||||
xf = SubElement(cell_style_xfs, 'xf',
|
||||
{'numFmtId':"0", 'fontId':"0", 'fillId':"0", 'borderId':"0"})
|
||||
|
||||
def _write_cell_xfs(self, number_format_table, fonts_table, fills_table, borders_table):
|
||||
""" write styles combinations based on ids found in tables """
|
||||
|
||||
# writing the cellXfs
|
||||
cell_xfs = SubElement(self._root, 'cellXfs',
|
||||
{'count':'%d' % (len(self._style_list) + 1)})
|
||||
|
||||
# default
|
||||
def _get_default_vals():
|
||||
return dict(numFmtId='0', fontId='0', fillId='0',
|
||||
xfId='0', borderId='0')
|
||||
|
||||
SubElement(cell_xfs, 'xf', _get_default_vals())
|
||||
|
||||
for st in self._style_list:
|
||||
vals = _get_default_vals()
|
||||
|
||||
if hash(st.font) != hash(style.DEFAULTS.font):
|
||||
vals['fontId'] = fonts_table[hash(st.font)]
|
||||
vals['applyFont'] = '1'
|
||||
|
||||
if hash(st.borders) != hash(style.DEFAULTS.borders):
|
||||
vals['borderId'] = borders_table[hash(st.borders)]
|
||||
vals['applyBorder'] = '1'
|
||||
|
||||
if hash(st.fill) != hash(style.DEFAULTS.fill):
|
||||
vals['fillId'] = fills_table[hash(st.fill)]
|
||||
vals['applyFillId'] = '1'
|
||||
|
||||
if st.number_format != style.DEFAULTS.number_format:
|
||||
vals['numFmtId'] = '%d' % number_format_table[st.number_format]
|
||||
vals['applyNumberFormat'] = '1'
|
||||
|
||||
if hash(st.alignment) != hash(style.DEFAULTS.alignment):
|
||||
vals['applyAlignment'] = '1'
|
||||
|
||||
node = SubElement(cell_xfs, 'xf', vals)
|
||||
|
||||
if hash(st.alignment) != hash(style.DEFAULTS.alignment):
|
||||
alignments = {}
|
||||
|
||||
for align_attr in ['horizontal','vertical']:
|
||||
if hash(getattr(st.alignment, align_attr)) != hash(getattr(style.DEFAULTS.alignment, align_attr)):
|
||||
alignments[align_attr] = getattr(st.alignment, align_attr)
|
||||
|
||||
SubElement(node, 'alignment', alignments)
|
||||
|
||||
|
||||
def _write_cell_style(self):
|
||||
cell_styles = SubElement(self._root, 'cellStyles', {'count':'1'})
|
||||
cell_style = SubElement(cell_styles, 'cellStyle',
|
||||
{'name':"Normal", 'xfId':"0", 'builtinId':"0"})
|
||||
|
||||
def _write_dxfs(self):
|
||||
dxfs = SubElement(self._root, 'dxfs', {'count':'0'})
|
||||
|
||||
def _write_table_styles(self):
|
||||
|
||||
table_styles = SubElement(self._root, 'tableStyles',
|
||||
{'count':'0', 'defaultTableStyle':'TableStyleMedium9',
|
||||
'defaultPivotStyle':'PivotStyleLight16'})
|
||||
|
||||
def _write_number_formats(self):
|
||||
|
||||
number_format_table = {}
|
||||
|
||||
number_format_list = []
|
||||
exceptions_list = []
|
||||
num_fmt_id = 165 # start at a greatly higher value as any builtin can go
|
||||
num_fmt_offset = 0
|
||||
|
||||
for style in self._style_list:
|
||||
|
||||
if not style.number_format in number_format_list :
|
||||
number_format_list.append(style.number_format)
|
||||
|
||||
for number_format in number_format_list:
|
||||
|
||||
if number_format.is_builtin():
|
||||
btin = number_format.builtin_format_id(number_format.format_code)
|
||||
number_format_table[number_format] = btin
|
||||
else:
|
||||
number_format_table[number_format] = num_fmt_id + num_fmt_offset
|
||||
num_fmt_offset += 1
|
||||
exceptions_list.append(number_format)
|
||||
|
||||
num_fmts = SubElement(self._root, 'numFmts',
|
||||
{'count':'%d' % len(exceptions_list)})
|
||||
|
||||
for number_format in exceptions_list :
|
||||
SubElement(num_fmts, 'numFmt',
|
||||
{'numFmtId':'%d' % number_format_table[number_format],
|
||||
'formatCode':'%s' % number_format.format_code})
|
||||
|
||||
return number_format_table
|
||||
@@ -0,0 +1,202 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# file openpyxl/writer/theme.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write the theme xml based on a fixed string."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, get_document_content
|
||||
|
||||
|
||||
def write_theme():
|
||||
"""Write the theme xml."""
|
||||
xml_node = fromstring(
|
||||
'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n'
|
||||
|
||||
'<a:theme xmlns:a="http://schemas.openxmlformats.org/'
|
||||
'drawingml/2006/main" name="Office Theme">'
|
||||
'<a:themeElements>'
|
||||
|
||||
'<a:clrScheme name="Office">'
|
||||
'<a:dk1><a:sysClr val="windowText" lastClr="000000"/></a:dk1>'
|
||||
'<a:lt1><a:sysClr val="window" lastClr="FFFFFF"/></a:lt1>'
|
||||
'<a:dk2><a:srgbClr val="1F497D"/></a:dk2>'
|
||||
'<a:lt2><a:srgbClr val="EEECE1"/></a:lt2>'
|
||||
'<a:accent1><a:srgbClr val="4F81BD"/></a:accent1>'
|
||||
'<a:accent2><a:srgbClr val="C0504D"/></a:accent2>'
|
||||
'<a:accent3><a:srgbClr val="9BBB59"/></a:accent3>'
|
||||
'<a:accent4><a:srgbClr val="8064A2"/></a:accent4>'
|
||||
'<a:accent5><a:srgbClr val="4BACC6"/></a:accent5>'
|
||||
'<a:accent6><a:srgbClr val="F79646"/></a:accent6>'
|
||||
'<a:hlink><a:srgbClr val="0000FF"/></a:hlink>'
|
||||
'<a:folHlink><a:srgbClr val="800080"/></a:folHlink>'
|
||||
'</a:clrScheme>'
|
||||
|
||||
'<a:fontScheme name="Office">'
|
||||
'<a:majorFont>'
|
||||
'<a:latin typeface="Cambria"/>'
|
||||
'<a:ea typeface=""/>'
|
||||
'<a:cs typeface=""/>'
|
||||
'<a:font script="Jpan" typeface="MS Pゴシック"/>'
|
||||
'<a:font script="Hang" typeface="맑은 고딕"/>'
|
||||
'<a:font script="Hans" typeface="宋体"/>'
|
||||
'<a:font script="Hant" typeface="新細明體"/>'
|
||||
'<a:font script="Arab" typeface="Times New Roman"/>'
|
||||
'<a:font script="Hebr" typeface="Times New Roman"/>'
|
||||
'<a:font script="Thai" typeface="Tahoma"/>'
|
||||
'<a:font script="Ethi" typeface="Nyala"/>'
|
||||
'<a:font script="Beng" typeface="Vrinda"/>'
|
||||
'<a:font script="Gujr" typeface="Shruti"/>'
|
||||
'<a:font script="Khmr" typeface="MoolBoran"/>'
|
||||
'<a:font script="Knda" typeface="Tunga"/>'
|
||||
'<a:font script="Guru" typeface="Raavi"/>'
|
||||
'<a:font script="Cans" typeface="Euphemia"/>'
|
||||
'<a:font script="Cher" typeface="Plantagenet Cherokee"/>'
|
||||
'<a:font script="Yiii" typeface="Microsoft Yi Baiti"/>'
|
||||
'<a:font script="Tibt" typeface="Microsoft Himalaya"/>'
|
||||
'<a:font script="Thaa" typeface="MV Boli"/>'
|
||||
'<a:font script="Deva" typeface="Mangal"/>'
|
||||
'<a:font script="Telu" typeface="Gautami"/>'
|
||||
'<a:font script="Taml" typeface="Latha"/>'
|
||||
'<a:font script="Syrc" typeface="Estrangelo Edessa"/>'
|
||||
'<a:font script="Orya" typeface="Kalinga"/>'
|
||||
'<a:font script="Mlym" typeface="Kartika"/>'
|
||||
'<a:font script="Laoo" typeface="DokChampa"/>'
|
||||
'<a:font script="Sinh" typeface="Iskoola Pota"/>'
|
||||
'<a:font script="Mong" typeface="Mongolian Baiti"/>'
|
||||
'<a:font script="Viet" typeface="Times New Roman"/>'
|
||||
'<a:font script="Uigh" typeface="Microsoft Uighur"/>'
|
||||
'</a:majorFont>'
|
||||
'<a:minorFont>'
|
||||
'<a:latin typeface="Calibri"/>'
|
||||
'<a:ea typeface=""/>'
|
||||
'<a:cs typeface=""/>'
|
||||
'<a:font script="Jpan" typeface="MS Pゴシック"/>'
|
||||
'<a:font script="Hang" typeface="맑은 고딕"/>'
|
||||
'<a:font script="Hans" typeface="宋体"/>'
|
||||
'<a:font script="Hant" typeface="新細明體"/>'
|
||||
'<a:font script="Arab" typeface="Arial"/>'
|
||||
'<a:font script="Hebr" typeface="Arial"/>'
|
||||
'<a:font script="Thai" typeface="Tahoma"/>'
|
||||
'<a:font script="Ethi" typeface="Nyala"/>'
|
||||
'<a:font script="Beng" typeface="Vrinda"/>'
|
||||
'<a:font script="Gujr" typeface="Shruti"/>'
|
||||
'<a:font script="Khmr" typeface="DaunPenh"/>'
|
||||
'<a:font script="Knda" typeface="Tunga"/>'
|
||||
'<a:font script="Guru" typeface="Raavi"/>'
|
||||
'<a:font script="Cans" typeface="Euphemia"/>'
|
||||
'<a:font script="Cher" typeface="Plantagenet Cherokee"/>'
|
||||
'<a:font script="Yiii" typeface="Microsoft Yi Baiti"/>'
|
||||
'<a:font script="Tibt" typeface="Microsoft Himalaya"/>'
|
||||
'<a:font script="Thaa" typeface="MV Boli"/>'
|
||||
'<a:font script="Deva" typeface="Mangal"/>'
|
||||
'<a:font script="Telu" typeface="Gautami"/>'
|
||||
'<a:font script="Taml" typeface="Latha"/>'
|
||||
'<a:font script="Syrc" typeface="Estrangelo Edessa"/>'
|
||||
'<a:font script="Orya" typeface="Kalinga"/>'
|
||||
'<a:font script="Mlym" typeface="Kartika"/>'
|
||||
'<a:font script="Laoo" typeface="DokChampa"/>'
|
||||
'<a:font script="Sinh" typeface="Iskoola Pota"/>'
|
||||
'<a:font script="Mong" typeface="Mongolian Baiti"/>'
|
||||
'<a:font script="Viet" typeface="Arial"/>'
|
||||
'<a:font script="Uigh" typeface="Microsoft Uighur"/>'
|
||||
'</a:minorFont>'
|
||||
'</a:fontScheme>'
|
||||
|
||||
'<a:fmtScheme name="Office">'
|
||||
'<a:fillStyleLst>'
|
||||
'<a:solidFill><a:schemeClr val="phClr"/></a:solidFill>'
|
||||
'<a:gradFill rotWithShape="1"><a:gsLst>'
|
||||
'<a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="50000"/>'
|
||||
'<a:satMod val="300000"/></a:schemeClr></a:gs>'
|
||||
'<a:gs pos="35000"><a:schemeClr val="phClr"><a:tint val="37000"/>'
|
||||
'<a:satMod val="300000"/></a:schemeClr></a:gs>'
|
||||
'<a:gs pos="100000"><a:schemeClr val="phClr"><a:tint val="15000"/>'
|
||||
'<a:satMod val="350000"/></a:schemeClr></a:gs></a:gsLst>'
|
||||
'<a:lin ang="16200000" scaled="1"/></a:gradFill>'
|
||||
'<a:gradFill rotWithShape="1"><a:gsLst>'
|
||||
'<a:gs pos="0"><a:schemeClr val="phClr"><a:shade val="51000"/>'
|
||||
'<a:satMod val="130000"/></a:schemeClr></a:gs>'
|
||||
'<a:gs pos="80000"><a:schemeClr val="phClr"><a:shade val="93000"/>'
|
||||
'<a:satMod val="130000"/></a:schemeClr></a:gs>'
|
||||
'<a:gs pos="100000"><a:schemeClr val="phClr">'
|
||||
'<a:shade val="94000"/>'
|
||||
'<a:satMod val="135000"/></a:schemeClr></a:gs></a:gsLst>'
|
||||
'<a:lin ang="16200000" scaled="0"/></a:gradFill></a:fillStyleLst>'
|
||||
'<a:lnStyleLst>'
|
||||
'<a:ln w="9525" cap="flat" cmpd="sng" algn="ctr">'
|
||||
'<a:solidFill><a:schemeClr val="phClr"><a:shade val="95000"/>'
|
||||
'<a:satMod val="105000"/></a:schemeClr></a:solidFill>'
|
||||
'<a:prstDash val="solid"/></a:ln>'
|
||||
'<a:ln w="25400" cap="flat" cmpd="sng" algn="ctr"><a:solidFill>'
|
||||
'<a:schemeClr val="phClr"/></a:solidFill>'
|
||||
'<a:prstDash val="solid"/></a:ln>'
|
||||
'<a:ln w="38100" cap="flat" cmpd="sng" algn="ctr"><a:solidFill>'
|
||||
'<a:schemeClr val="phClr"/></a:solidFill>'
|
||||
'<a:prstDash val="solid"/></a:ln></a:lnStyleLst>'
|
||||
'<a:effectStyleLst><a:effectStyle><a:effectLst>'
|
||||
'<a:outerShdw blurRad="40000" dist="20000" dir="5400000" '
|
||||
'rotWithShape="0"><a:srgbClr val="000000">'
|
||||
'<a:alpha val="38000"/></a:srgbClr></a:outerShdw></a:effectLst>'
|
||||
'</a:effectStyle><a:effectStyle><a:effectLst>'
|
||||
'<a:outerShdw blurRad="40000" dist="23000" dir="5400000" '
|
||||
'rotWithShape="0"><a:srgbClr val="000000">'
|
||||
'<a:alpha val="35000"/></a:srgbClr></a:outerShdw></a:effectLst>'
|
||||
'</a:effectStyle><a:effectStyle><a:effectLst>'
|
||||
'<a:outerShdw blurRad="40000" dist="23000" dir="5400000" '
|
||||
'rotWithShape="0"><a:srgbClr val="000000">'
|
||||
'<a:alpha val="35000"/></a:srgbClr></a:outerShdw></a:effectLst>'
|
||||
'<a:scene3d><a:camera prst="orthographicFront">'
|
||||
'<a:rot lat="0" lon="0" rev="0"/></a:camera>'
|
||||
'<a:lightRig rig="threePt" dir="t">'
|
||||
'<a:rot lat="0" lon="0" rev="1200000"/></a:lightRig>'
|
||||
'</a:scene3d><a:sp3d><a:bevelT w="63500" h="25400"/>'
|
||||
'</a:sp3d></a:effectStyle></a:effectStyleLst>'
|
||||
'<a:bgFillStyleLst><a:solidFill><a:schemeClr val="phClr"/>'
|
||||
'</a:solidFill><a:gradFill rotWithShape="1"><a:gsLst>'
|
||||
'<a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="40000"/>'
|
||||
'<a:satMod val="350000"/></a:schemeClr></a:gs>'
|
||||
'<a:gs pos="40000"><a:schemeClr val="phClr"><a:tint val="45000"/>'
|
||||
'<a:shade val="99000"/><a:satMod val="350000"/>'
|
||||
'</a:schemeClr></a:gs>'
|
||||
'<a:gs pos="100000"><a:schemeClr val="phClr">'
|
||||
'<a:shade val="20000"/><a:satMod val="255000"/>'
|
||||
'</a:schemeClr></a:gs></a:gsLst>'
|
||||
'<a:path path="circle">'
|
||||
'<a:fillToRect l="50000" t="-80000" r="50000" b="180000"/>'
|
||||
'</a:path>'
|
||||
'</a:gradFill><a:gradFill rotWithShape="1"><a:gsLst>'
|
||||
'<a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="80000"/>'
|
||||
'<a:satMod val="300000"/></a:schemeClr></a:gs>'
|
||||
'<a:gs pos="100000"><a:schemeClr val="phClr">'
|
||||
'<a:shade val="30000"/><a:satMod val="200000"/>'
|
||||
'</a:schemeClr></a:gs></a:gsLst>'
|
||||
'<a:path path="circle">'
|
||||
'<a:fillToRect l="50000" t="50000" r="50000" b="50000"/></a:path>'
|
||||
'</a:gradFill></a:bgFillStyleLst></a:fmtScheme>'
|
||||
'</a:themeElements>'
|
||||
'<a:objectDefaults/><a:extraClrSchemeLst/>'
|
||||
'</a:theme>')
|
||||
return get_document_content(xml_node)
|
||||
@@ -0,0 +1,204 @@
|
||||
# file openpyxl/writer/workbook.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write the workbook global settings to the archive."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import Element, SubElement
|
||||
from ..cell import absolute_coordinate
|
||||
from ..shared.xmltools import get_document_content
|
||||
from ..shared.ooxml import NAMESPACES, ARC_CORE, ARC_WORKBOOK, \
|
||||
ARC_APP, ARC_THEME, ARC_STYLE, ARC_SHARED_STRINGS
|
||||
from ..shared.date_time import datetime_to_W3CDTF
|
||||
|
||||
|
||||
def write_properties_core(properties):
|
||||
"""Write the core properties to xml."""
|
||||
root = Element('cp:coreProperties', {'xmlns:cp': NAMESPACES['cp'],
|
||||
'xmlns:xsi': NAMESPACES['xsi'], 'xmlns:dc': NAMESPACES['dc'],
|
||||
'xmlns:dcterms': NAMESPACES['dcterms'],
|
||||
'xmlns:dcmitype': NAMESPACES['dcmitype'], })
|
||||
SubElement(root, 'dc:creator').text = properties.creator
|
||||
SubElement(root, 'cp:lastModifiedBy').text = properties.last_modified_by
|
||||
SubElement(root, 'dcterms:created', \
|
||||
{'xsi:type': 'dcterms:W3CDTF'}).text = \
|
||||
datetime_to_W3CDTF(properties.created)
|
||||
SubElement(root, 'dcterms:modified',
|
||||
{'xsi:type': 'dcterms:W3CDTF'}).text = \
|
||||
datetime_to_W3CDTF(properties.modified)
|
||||
return get_document_content(root)
|
||||
|
||||
|
||||
def write_content_types(workbook):
|
||||
"""Write the content-types xml."""
|
||||
root = Element('Types', {'xmlns': 'http://schemas.openxmlformats.org/package/2006/content-types'})
|
||||
SubElement(root, 'Override', {'PartName': '/' + ARC_THEME, 'ContentType': 'application/vnd.openxmlformats-officedocument.theme+xml'})
|
||||
SubElement(root, 'Override', {'PartName': '/' + ARC_STYLE, 'ContentType': 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml'})
|
||||
SubElement(root, 'Default', {'Extension': 'rels', 'ContentType': 'application/vnd.openxmlformats-package.relationships+xml'})
|
||||
SubElement(root, 'Default', {'Extension': 'xml', 'ContentType': 'application/xml'})
|
||||
SubElement(root, 'Override', {'PartName': '/' + ARC_WORKBOOK, 'ContentType': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'})
|
||||
SubElement(root, 'Override', {'PartName': '/' + ARC_APP, 'ContentType': 'application/vnd.openxmlformats-officedocument.extended-properties+xml'})
|
||||
SubElement(root, 'Override', {'PartName': '/' + ARC_CORE, 'ContentType': 'application/vnd.openxmlformats-package.core-properties+xml'})
|
||||
SubElement(root, 'Override', {'PartName': '/' + ARC_SHARED_STRINGS, 'ContentType': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml'})
|
||||
|
||||
drawing_id = 1
|
||||
chart_id = 1
|
||||
|
||||
for sheet_id, sheet in enumerate(workbook.worksheets):
|
||||
SubElement(root, 'Override',
|
||||
{'PartName': '/xl/worksheets/sheet%d.xml' % (sheet_id + 1),
|
||||
'ContentType': 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'})
|
||||
if sheet._charts:
|
||||
SubElement(root, 'Override',
|
||||
{'PartName' : '/xl/drawings/drawing%d.xml' % (sheet_id + 1),
|
||||
'ContentType' : 'application/vnd.openxmlformats-officedocument.drawing+xml'})
|
||||
drawing_id += 1
|
||||
|
||||
for chart in sheet._charts:
|
||||
SubElement(root, 'Override',
|
||||
{'PartName' : '/xl/charts/chart%d.xml' % chart_id,
|
||||
'ContentType' : 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml'})
|
||||
chart_id += 1
|
||||
if chart._shapes:
|
||||
SubElement(root, 'Override',
|
||||
{'PartName' : '/xl/drawings/drawing%d.xml' % drawing_id,
|
||||
'ContentType' : 'application/vnd.openxmlformats-officedocument.drawingml.chartshapes+xml'})
|
||||
drawing_id += 1
|
||||
|
||||
return get_document_content(root)
|
||||
|
||||
|
||||
def write_properties_app(workbook):
|
||||
"""Write the properties xml."""
|
||||
worksheets_count = len(workbook.worksheets)
|
||||
root = Element('Properties', {'xmlns': 'http://schemas.openxmlformats.org/officeDocument/2006/extended-properties',
|
||||
'xmlns:vt': 'http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes'})
|
||||
SubElement(root, 'Application').text = 'Microsoft Excel'
|
||||
SubElement(root, 'DocSecurity').text = '0'
|
||||
SubElement(root, 'ScaleCrop').text = 'false'
|
||||
SubElement(root, 'Company')
|
||||
SubElement(root, 'LinksUpToDate').text = 'false'
|
||||
SubElement(root, 'SharedDoc').text = 'false'
|
||||
SubElement(root, 'HyperlinksChanged').text = 'false'
|
||||
SubElement(root, 'AppVersion').text = '12.0000'
|
||||
|
||||
# heading pairs part
|
||||
heading_pairs = SubElement(root, 'HeadingPairs')
|
||||
vector = SubElement(heading_pairs, 'vt:vector',
|
||||
{'size': '2', 'baseType': 'variant'})
|
||||
variant = SubElement(vector, 'vt:variant')
|
||||
SubElement(variant, 'vt:lpstr').text = 'Worksheets'
|
||||
variant = SubElement(vector, 'vt:variant')
|
||||
SubElement(variant, 'vt:i4').text = '%d' % worksheets_count
|
||||
|
||||
# title of parts
|
||||
title_of_parts = SubElement(root, 'TitlesOfParts')
|
||||
vector = SubElement(title_of_parts, 'vt:vector',
|
||||
{'size': '%d' % worksheets_count, 'baseType': 'lpstr'})
|
||||
for ws in workbook.worksheets:
|
||||
SubElement(vector, 'vt:lpstr').text = '%s' % ws.title
|
||||
return get_document_content(root)
|
||||
|
||||
|
||||
def write_root_rels(workbook):
|
||||
"""Write the relationships xml."""
|
||||
root = Element('Relationships', {'xmlns':
|
||||
'http://schemas.openxmlformats.org/package/2006/relationships'})
|
||||
SubElement(root, 'Relationship', {'Id': 'rId1', 'Target': ARC_WORKBOOK,
|
||||
'Type': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'})
|
||||
SubElement(root, 'Relationship', {'Id': 'rId2', 'Target': ARC_CORE,
|
||||
'Type': 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'})
|
||||
SubElement(root, 'Relationship', {'Id': 'rId3', 'Target': ARC_APP,
|
||||
'Type': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties'})
|
||||
return get_document_content(root)
|
||||
|
||||
|
||||
def write_workbook(workbook):
|
||||
"""Write the core workbook xml."""
|
||||
root = Element('workbook', {'xmlns': 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
|
||||
'xml:space': 'preserve', 'xmlns:r': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'})
|
||||
SubElement(root, 'fileVersion', {'appName': 'xl', 'lastEdited': '4',
|
||||
'lowestEdited': '4', 'rupBuild': '4505'})
|
||||
SubElement(root, 'workbookPr', {'defaultThemeVersion': '124226',
|
||||
'codeName': 'ThisWorkbook'})
|
||||
book_views = SubElement(root, 'bookViews')
|
||||
SubElement(book_views, 'workbookView', {'activeTab': '%d' % workbook.get_index(workbook.get_active_sheet()),
|
||||
'autoFilterDateGrouping': '1', 'firstSheet': '0', 'minimized': '0',
|
||||
'showHorizontalScroll': '1', 'showSheetTabs': '1',
|
||||
'showVerticalScroll': '1', 'tabRatio': '600',
|
||||
'visibility': 'visible'})
|
||||
# worksheets
|
||||
sheets = SubElement(root, 'sheets')
|
||||
for i, sheet in enumerate(workbook.worksheets):
|
||||
sheet_node = SubElement(sheets, 'sheet', {'name': sheet.title,
|
||||
'sheetId': '%d' % (i + 1), 'r:id': 'rId%d' % (i + 1)})
|
||||
if not sheet.sheet_state == sheet.SHEETSTATE_VISIBLE:
|
||||
sheet_node.set('state', sheet.sheet_state)
|
||||
# named ranges
|
||||
defined_names = SubElement(root, 'definedNames')
|
||||
for named_range in workbook.get_named_ranges():
|
||||
name = SubElement(defined_names, 'definedName',
|
||||
{'name': named_range.name})
|
||||
|
||||
# as there can be many cells in one range, generate the list of ranges
|
||||
dest_cells = []
|
||||
cell_ids = []
|
||||
for worksheet, range_name in named_range.destinations:
|
||||
cell_ids.append(workbook.get_index(worksheet))
|
||||
dest_cells.append("'%s'!%s" % (worksheet.title.replace("'", "''"),
|
||||
absolute_coordinate(range_name)))
|
||||
|
||||
# for local ranges, we must check all the cells belong to the same sheet
|
||||
base_id = cell_ids[0]
|
||||
if named_range.local_only and all([x == base_id for x in cell_ids]):
|
||||
name.set('localSheetId', '%s' % base_id)
|
||||
|
||||
# finally write the cells list
|
||||
name.text = ','.join(dest_cells)
|
||||
|
||||
SubElement(root, 'calcPr', {'calcId': '124519', 'calcMode': 'auto',
|
||||
'fullCalcOnLoad': '1'})
|
||||
return get_document_content(root)
|
||||
|
||||
|
||||
def write_workbook_rels(workbook):
|
||||
"""Write the workbook relationships xml."""
|
||||
root = Element('Relationships', {'xmlns':
|
||||
'http://schemas.openxmlformats.org/package/2006/relationships'})
|
||||
for i in range(len(workbook.worksheets)):
|
||||
SubElement(root, 'Relationship', {'Id': 'rId%d' % (i + 1),
|
||||
'Type': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet',
|
||||
'Target': 'worksheets/sheet%s.xml' % (i + 1)})
|
||||
rid = len(workbook.worksheets) + 1
|
||||
SubElement(root, 'Relationship',
|
||||
{'Id': 'rId%d' % rid, 'Target': 'sharedStrings.xml',
|
||||
'Type': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings'})
|
||||
SubElement(root, 'Relationship',
|
||||
{'Id': 'rId%d' % (rid + 1), 'Target': 'styles.xml',
|
||||
'Type': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles'})
|
||||
SubElement(root, 'Relationship',
|
||||
{'Id': 'rId%d' % (rid + 2), 'Target': 'theme/theme1.xml',
|
||||
'Type': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme'})
|
||||
return get_document_content(root)
|
||||
@@ -0,0 +1,209 @@
|
||||
# file openpyxl/writer/worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Write worksheets to xml representations."""
|
||||
|
||||
# Python stdlib imports
|
||||
from ....compat import BytesIO as StringIO # cStringIO doesn't handle unicode
|
||||
|
||||
# package imports
|
||||
from ..cell import coordinate_from_string, column_index_from_string
|
||||
from ..shared.xmltools import Element, SubElement, XMLGenerator, \
|
||||
get_document_content, start_tag, end_tag, tag
|
||||
|
||||
|
||||
def row_sort(cell):
|
||||
"""Translate column names for sorting."""
|
||||
return column_index_from_string(cell.column)
|
||||
|
||||
|
||||
def write_worksheet(worksheet, string_table, style_table):
|
||||
"""Write a worksheet to an xml file."""
|
||||
xml_file = StringIO()
|
||||
doc = XMLGenerator(xml_file, 'utf-8')
|
||||
start_tag(doc, 'worksheet',
|
||||
{'xml:space': 'preserve',
|
||||
'xmlns': 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
|
||||
'xmlns:r': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'})
|
||||
start_tag(doc, 'sheetPr')
|
||||
tag(doc, 'outlinePr',
|
||||
{'summaryBelow': '%d' % (worksheet.show_summary_below),
|
||||
'summaryRight': '%d' % (worksheet.show_summary_right)})
|
||||
end_tag(doc, 'sheetPr')
|
||||
tag(doc, 'dimension', {'ref': '%s' % worksheet.calculate_dimension()})
|
||||
write_worksheet_sheetviews(doc, worksheet)
|
||||
tag(doc, 'sheetFormatPr', {'defaultRowHeight': '15'})
|
||||
write_worksheet_cols(doc, worksheet)
|
||||
write_worksheet_data(doc, worksheet, string_table, style_table)
|
||||
if worksheet.auto_filter:
|
||||
tag(doc, 'autoFilter', {'ref': worksheet.auto_filter})
|
||||
write_worksheet_hyperlinks(doc, worksheet)
|
||||
if worksheet._charts:
|
||||
tag(doc, 'drawing', {'r:id':'rId1'})
|
||||
end_tag(doc, 'worksheet')
|
||||
doc.endDocument()
|
||||
xml_string = xml_file.getvalue()
|
||||
xml_file.close()
|
||||
return xml_string
|
||||
|
||||
def write_worksheet_sheetviews(doc, worksheet):
|
||||
start_tag(doc, 'sheetViews')
|
||||
start_tag(doc, 'sheetView', {'workbookViewId': '0'})
|
||||
selectionAttrs = {}
|
||||
topLeftCell = worksheet.freeze_panes
|
||||
if topLeftCell:
|
||||
colName, row = coordinate_from_string(topLeftCell)
|
||||
column = column_index_from_string(colName)
|
||||
pane = 'topRight'
|
||||
paneAttrs = {}
|
||||
if column > 1:
|
||||
paneAttrs['xSplit'] = str(column - 1)
|
||||
if row > 1:
|
||||
paneAttrs['ySplit'] = str(row - 1)
|
||||
pane = 'bottomLeft'
|
||||
if column > 1:
|
||||
pane = 'bottomRight'
|
||||
paneAttrs.update(dict(topLeftCell=topLeftCell,
|
||||
activePane=pane,
|
||||
state='frozen'))
|
||||
tag(doc, 'pane', paneAttrs)
|
||||
selectionAttrs['pane'] = pane
|
||||
if row > 1 and column > 1:
|
||||
tag(doc, 'selection', {'pane': 'topRight'})
|
||||
tag(doc, 'selection', {'pane': 'bottomLeft'})
|
||||
|
||||
selectionAttrs.update({'activeCell': worksheet.active_cell,
|
||||
'sqref': worksheet.selected_cell})
|
||||
|
||||
tag(doc, 'selection', selectionAttrs)
|
||||
end_tag(doc, 'sheetView')
|
||||
end_tag(doc, 'sheetViews')
|
||||
|
||||
|
||||
def write_worksheet_cols(doc, worksheet):
|
||||
"""Write worksheet columns to xml."""
|
||||
if worksheet.column_dimensions:
|
||||
start_tag(doc, 'cols')
|
||||
for column_string, columndimension in \
|
||||
worksheet.column_dimensions.items():
|
||||
col_index = column_index_from_string(column_string)
|
||||
col_def = {}
|
||||
col_def['collapsed'] = str(columndimension.style_index)
|
||||
col_def['min'] = str(col_index)
|
||||
col_def['max'] = str(col_index)
|
||||
if columndimension.width != \
|
||||
worksheet.default_column_dimension.width:
|
||||
col_def['customWidth'] = 'true'
|
||||
if not columndimension.visible:
|
||||
col_def['hidden'] = 'true'
|
||||
if columndimension.outline_level > 0:
|
||||
col_def['outlineLevel'] = str(columndimension.outline_level)
|
||||
if columndimension.collapsed:
|
||||
col_def['collapsed'] = 'true'
|
||||
if columndimension.auto_size:
|
||||
col_def['bestFit'] = 'true'
|
||||
if columndimension.width > 0:
|
||||
col_def['width'] = str(columndimension.width)
|
||||
else:
|
||||
col_def['width'] = '9.10'
|
||||
tag(doc, 'col', col_def)
|
||||
end_tag(doc, 'cols')
|
||||
|
||||
|
||||
def write_worksheet_data(doc, worksheet, string_table, style_table):
|
||||
"""Write worksheet data to xml."""
|
||||
start_tag(doc, 'sheetData')
|
||||
max_column = worksheet.get_highest_column()
|
||||
style_id_by_hash = style_table
|
||||
cells_by_row = {}
|
||||
for cell in worksheet.get_cell_collection():
|
||||
cells_by_row.setdefault(cell.row, []).append(cell)
|
||||
for row_idx in sorted(cells_by_row):
|
||||
row_dimension = worksheet.row_dimensions[row_idx]
|
||||
attrs = {'r': '%d' % row_idx,
|
||||
'spans': '1:%d' % max_column}
|
||||
if row_dimension.height > 0:
|
||||
attrs['ht'] = str(row_dimension.height)
|
||||
attrs['customHeight'] = '1'
|
||||
start_tag(doc, 'row', attrs)
|
||||
row_cells = cells_by_row[row_idx]
|
||||
sorted_cells = sorted(row_cells, key = row_sort)
|
||||
for cell in sorted_cells:
|
||||
value = cell._value
|
||||
coordinate = cell.get_coordinate()
|
||||
attributes = {'r': coordinate}
|
||||
attributes['t'] = cell.data_type
|
||||
if coordinate in worksheet._styles:
|
||||
attributes['s'] = '%d' % style_id_by_hash[
|
||||
hash(worksheet._styles[coordinate])]
|
||||
start_tag(doc, 'c', attributes)
|
||||
if value is None:
|
||||
tag(doc, 'v', body='')
|
||||
elif cell.data_type == cell.TYPE_STRING:
|
||||
tag(doc, 'v', body = '%s' % string_table[value])
|
||||
elif cell.data_type == cell.TYPE_FORMULA:
|
||||
tag(doc, 'f', body = '%s' % value[1:])
|
||||
tag(doc, 'v')
|
||||
elif cell.data_type == cell.TYPE_NUMERIC:
|
||||
tag(doc, 'v', body = '%s' % value)
|
||||
else:
|
||||
tag(doc, 'v', body = '%s' % value)
|
||||
end_tag(doc, 'c')
|
||||
end_tag(doc, 'row')
|
||||
end_tag(doc, 'sheetData')
|
||||
|
||||
|
||||
def write_worksheet_hyperlinks(doc, worksheet):
|
||||
"""Write worksheet hyperlinks to xml."""
|
||||
write_hyperlinks = False
|
||||
for cell in worksheet.get_cell_collection():
|
||||
if cell.hyperlink_rel_id is not None:
|
||||
write_hyperlinks = True
|
||||
break
|
||||
if write_hyperlinks:
|
||||
start_tag(doc, 'hyperlinks')
|
||||
for cell in worksheet.get_cell_collection():
|
||||
if cell.hyperlink_rel_id is not None:
|
||||
attrs = {'display': cell.hyperlink,
|
||||
'ref': cell.get_coordinate(),
|
||||
'r:id': cell.hyperlink_rel_id}
|
||||
tag(doc, 'hyperlink', attrs)
|
||||
end_tag(doc, 'hyperlinks')
|
||||
|
||||
|
||||
def write_worksheet_rels(worksheet, idx):
|
||||
"""Write relationships for the worksheet to xml."""
|
||||
root = Element('Relationships', {'xmlns': 'http://schemas.openxmlformats.org/package/2006/relationships'})
|
||||
for rel in worksheet.relationships:
|
||||
attrs = {'Id': rel.id, 'Type': rel.type, 'Target': rel.target}
|
||||
if rel.target_mode:
|
||||
attrs['TargetMode'] = rel.target_mode
|
||||
SubElement(root, 'Relationship', attrs)
|
||||
if worksheet._charts:
|
||||
attrs = {'Id' : 'rId1',
|
||||
'Type' : 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing',
|
||||
'Target' : '../drawings/drawing%s.xml' % idx }
|
||||
SubElement(root, 'Relationship', attrs)
|
||||
return get_document_content(root)
|
||||
@@ -0,0 +1,53 @@
|
||||
# file openpyxl/__init__.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Imports for the openpyxl package."""
|
||||
|
||||
# package imports
|
||||
from . import cell
|
||||
from . import namedrange
|
||||
from . import style
|
||||
from . import workbook
|
||||
from . import worksheet
|
||||
from . import reader
|
||||
from . import shared
|
||||
from . import writer
|
||||
|
||||
# constants
|
||||
|
||||
__major__ = 1 # for major interface/format changes
|
||||
__minor__ = 5 # for minor interface/format changes
|
||||
__release__ = 2 # for tweaks, bug-fixes, or development
|
||||
|
||||
__version__ = '%d.%d.%d' % (__major__, __minor__, __release__)
|
||||
|
||||
__author__ = 'Eric Gazoni'
|
||||
__license__ = 'MIT/Expat'
|
||||
__author_email__ = 'eric.gazoni@gmail.com'
|
||||
__maintainer_email__ = 'openpyxl-users@googlegroups.com'
|
||||
__url__ = 'http://bitbucket.org/ericgazoni/openpyxl/wiki/Home'
|
||||
__downloadUrl__ = "http://bitbucket.org/ericgazoni/openpyxl/downloads"
|
||||
|
||||
__all__ = ('reader', 'shared', 'writer',)
|
||||
@@ -0,0 +1,384 @@
|
||||
# file openpyxl/cell.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Manage individual cells in a spreadsheet.
|
||||
|
||||
The Cell class is required to know its value and type, display options,
|
||||
and any other features of an Excel cell. Utilities for referencing
|
||||
cells using Excel's 'A1' column/row nomenclature are also provided.
|
||||
|
||||
"""
|
||||
|
||||
__docformat__ = "restructuredtext en"
|
||||
|
||||
# Python stdlib imports
|
||||
import datetime
|
||||
import re
|
||||
|
||||
# package imports
|
||||
from .shared.date_time import SharedDate
|
||||
from .shared.exc import CellCoordinatesException, \
|
||||
ColumnStringIndexException, DataTypeException
|
||||
from .style import NumberFormat
|
||||
|
||||
# constants
|
||||
COORD_RE = re.compile('^[$]?([A-Z]+)[$]?(\d+)$')
|
||||
|
||||
ABSOLUTE_RE = re.compile('^[$]?([A-Z]+)[$]?(\d+)(:[$]?([A-Z]+)[$]?(\d+))?$')
|
||||
|
||||
def coordinate_from_string(coord_string):
|
||||
"""Convert a coordinate string like 'B12' to a tuple ('B', 12)"""
|
||||
match = COORD_RE.match(coord_string.upper())
|
||||
if not match:
|
||||
msg = 'Invalid cell coordinates (%s)' % coord_string
|
||||
raise CellCoordinatesException(msg)
|
||||
column, row = match.groups()
|
||||
return (column, int(row))
|
||||
|
||||
|
||||
def absolute_coordinate(coord_string):
|
||||
"""Convert a coordinate to an absolute coordinate string (B12 -> $B$12)"""
|
||||
parts = ABSOLUTE_RE.match(coord_string).groups()
|
||||
|
||||
if all(parts[-2:]):
|
||||
return '$%s$%s:$%s$%s' % (parts[0], parts[1], parts[3], parts[4])
|
||||
else:
|
||||
return '$%s$%s' % (parts[0], parts[1])
|
||||
|
||||
|
||||
def column_index_from_string(column, fast = False):
|
||||
"""Convert a column letter into a column number (e.g. B -> 2)
|
||||
|
||||
Excel only supports 1-3 letter column names from A -> ZZZ, so we
|
||||
restrict our column names to 1-3 characters, each in the range A-Z.
|
||||
|
||||
.. note::
|
||||
|
||||
Fast mode is faster but does not check that all letters are capitals between A and Z
|
||||
|
||||
"""
|
||||
column = column.upper()
|
||||
|
||||
clen = len(column)
|
||||
|
||||
if not fast and not all('A' <= char <= 'Z' for char in column):
|
||||
msg = 'Column string must contain only characters A-Z: got %s' % column
|
||||
raise ColumnStringIndexException(msg)
|
||||
|
||||
if clen == 1:
|
||||
return ord(column[0]) - 64
|
||||
elif clen == 2:
|
||||
return ((1 + (ord(column[0]) - 65)) * 26) + (ord(column[1]) - 64)
|
||||
elif clen == 3:
|
||||
return ((1 + (ord(column[0]) - 65)) * 676) + ((1 + (ord(column[1]) - 65)) * 26) + (ord(column[2]) - 64)
|
||||
elif clen > 3:
|
||||
raise ColumnStringIndexException('Column string index can not be longer than 3 characters')
|
||||
else:
|
||||
raise ColumnStringIndexException('Column string index can not be empty')
|
||||
|
||||
|
||||
def get_column_letter(col_idx):
|
||||
"""Convert a column number into a column letter (3 -> 'C')
|
||||
|
||||
Right shift the column col_idx by 26 to find column letters in reverse
|
||||
order. These numbers are 1-based, and can be converted to ASCII
|
||||
ordinals by adding 64.
|
||||
|
||||
"""
|
||||
# these indicies corrospond to A -> ZZZ and include all allowed
|
||||
# columns
|
||||
if not 1 <= col_idx <= 18278:
|
||||
msg = 'Column index out of bounds: %s' % col_idx
|
||||
raise ColumnStringIndexException(msg)
|
||||
ordinals = []
|
||||
temp = col_idx
|
||||
while temp:
|
||||
quotient, remainder = divmod(temp, 26)
|
||||
# check for exact division and borrow if needed
|
||||
if remainder == 0:
|
||||
quotient -= 1
|
||||
remainder = 26
|
||||
ordinals.append(remainder + 64)
|
||||
temp = quotient
|
||||
ordinals.reverse()
|
||||
return ''.join([chr(ordinal) for ordinal in ordinals])
|
||||
|
||||
|
||||
class Cell(object):
|
||||
"""Describes cell associated properties.
|
||||
|
||||
Properties of interest include style, type, value, and address.
|
||||
|
||||
"""
|
||||
__slots__ = ('column',
|
||||
'row',
|
||||
'_value',
|
||||
'_data_type',
|
||||
'parent',
|
||||
'xf_index',
|
||||
'_hyperlink_rel')
|
||||
|
||||
ERROR_CODES = {'#NULL!': 0,
|
||||
'#DIV/0!': 1,
|
||||
'#VALUE!': 2,
|
||||
'#REF!': 3,
|
||||
'#NAME?': 4,
|
||||
'#NUM!': 5,
|
||||
'#N/A': 6}
|
||||
|
||||
TYPE_STRING = 's'
|
||||
TYPE_FORMULA = 'f'
|
||||
TYPE_NUMERIC = 'n'
|
||||
TYPE_BOOL = 'b'
|
||||
TYPE_NULL = 's'
|
||||
TYPE_INLINE = 'inlineStr'
|
||||
TYPE_ERROR = 'e'
|
||||
|
||||
VALID_TYPES = [TYPE_STRING, TYPE_FORMULA, TYPE_NUMERIC, TYPE_BOOL,
|
||||
TYPE_NULL, TYPE_INLINE, TYPE_ERROR]
|
||||
|
||||
RE_PATTERNS = {
|
||||
'percentage': re.compile('^\-?[0-9]*\.?[0-9]*\s?\%$'),
|
||||
'time': re.compile('^(\d|[0-1]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$'),
|
||||
'numeric': re.compile('^\-?([0-9]+\\.?[0-9]*|[0-9]*\\.?[0-9]+)((E|e)\-?[0-9]+)?$'), }
|
||||
|
||||
def __init__(self, worksheet, column, row, value = None):
|
||||
self.column = column.upper()
|
||||
self.row = row
|
||||
# _value is the stored value, while value is the displayed value
|
||||
self._value = None
|
||||
self._hyperlink_rel = None
|
||||
self._data_type = self.TYPE_NULL
|
||||
if value:
|
||||
self.value = value
|
||||
self.parent = worksheet
|
||||
self.xf_index = 0
|
||||
|
||||
def __repr__(self):
|
||||
return "<Cell %s.%s>" % (self.parent.title, self.get_coordinate())
|
||||
|
||||
def check_string(self, value):
|
||||
"""Check string coding, length, and line break character"""
|
||||
# convert to unicode string
|
||||
value = str(value)
|
||||
# string must never be longer than 32,767 characters
|
||||
# truncate if necessary
|
||||
value = value[:32767]
|
||||
# we require that newline is represented as "\n" in core,
|
||||
# not as "\r\n" or "\r"
|
||||
value = value.replace('\r\n', '\n')
|
||||
return value
|
||||
|
||||
def check_numeric(self, value):
|
||||
"""Cast value to int or float if necessary"""
|
||||
if not isinstance(value, (int, float)):
|
||||
try:
|
||||
value = int(value)
|
||||
except ValueError:
|
||||
value = float(value)
|
||||
return value
|
||||
|
||||
def set_value_explicit(self, value = None, data_type = TYPE_STRING):
|
||||
"""Coerce values according to their explicit type"""
|
||||
type_coercion_map = {
|
||||
self.TYPE_INLINE: self.check_string,
|
||||
self.TYPE_STRING: self.check_string,
|
||||
self.TYPE_FORMULA: str,
|
||||
self.TYPE_NUMERIC: self.check_numeric,
|
||||
self.TYPE_BOOL: bool, }
|
||||
try:
|
||||
self._value = type_coercion_map[data_type](value)
|
||||
except KeyError:
|
||||
if data_type not in self.VALID_TYPES:
|
||||
msg = 'Invalid data type: %s' % data_type
|
||||
raise DataTypeException(msg)
|
||||
self._data_type = data_type
|
||||
|
||||
def data_type_for_value(self, value):
|
||||
"""Given a value, infer the correct data type"""
|
||||
if value is None:
|
||||
data_type = self.TYPE_NULL
|
||||
elif value is True or value is False:
|
||||
data_type = self.TYPE_BOOL
|
||||
elif isinstance(value, (int, float)):
|
||||
data_type = self.TYPE_NUMERIC
|
||||
elif not value:
|
||||
data_type = self.TYPE_STRING
|
||||
elif isinstance(value, (datetime.datetime, datetime.date)):
|
||||
data_type = self.TYPE_NUMERIC
|
||||
elif isinstance(value, str) and value[0] == '=':
|
||||
data_type = self.TYPE_FORMULA
|
||||
elif self.RE_PATTERNS['numeric'].match(value):
|
||||
data_type = self.TYPE_NUMERIC
|
||||
elif value.strip() in self.ERROR_CODES:
|
||||
data_type = self.TYPE_ERROR
|
||||
else:
|
||||
data_type = self.TYPE_STRING
|
||||
return data_type
|
||||
|
||||
def bind_value(self, value):
|
||||
"""Given a value, infer type and display options."""
|
||||
self._data_type = self.data_type_for_value(value)
|
||||
if value is None:
|
||||
self.set_value_explicit('', self.TYPE_NULL)
|
||||
return True
|
||||
elif self._data_type == self.TYPE_STRING:
|
||||
# percentage detection
|
||||
percentage_search = self.RE_PATTERNS['percentage'].match(value)
|
||||
if percentage_search and value.strip() != '%':
|
||||
value = float(value.replace('%', '')) / 100.0
|
||||
self.set_value_explicit(value, self.TYPE_NUMERIC)
|
||||
self._set_number_format(NumberFormat.FORMAT_PERCENTAGE)
|
||||
return True
|
||||
# time detection
|
||||
time_search = self.RE_PATTERNS['time'].match(value)
|
||||
if time_search:
|
||||
sep_count = value.count(':') #pylint: disable-msg=E1103
|
||||
if sep_count == 1:
|
||||
hours, minutes = [int(bit) for bit in value.split(':')] #pylint: disable-msg=E1103
|
||||
seconds = 0
|
||||
elif sep_count == 2:
|
||||
hours, minutes, seconds = \
|
||||
[int(bit) for bit in value.split(':')] #pylint: disable-msg=E1103
|
||||
days = (hours / 24.0) + (minutes / 1440.0) + \
|
||||
(seconds / 86400.0)
|
||||
self.set_value_explicit(days, self.TYPE_NUMERIC)
|
||||
self._set_number_format(NumberFormat.FORMAT_DATE_TIME3)
|
||||
return True
|
||||
if self._data_type == self.TYPE_NUMERIC:
|
||||
# date detection
|
||||
# if the value is a date, but not a date time, make it a
|
||||
# datetime, and set the time part to 0
|
||||
if isinstance(value, datetime.date) and not \
|
||||
isinstance(value, datetime.datetime):
|
||||
value = datetime.datetime.combine(value, datetime.time())
|
||||
if isinstance(value, datetime.datetime):
|
||||
value = SharedDate().datetime_to_julian(date = value)
|
||||
self.set_value_explicit(value, self.TYPE_NUMERIC)
|
||||
self._set_number_format(NumberFormat.FORMAT_DATE_YYYYMMDD2)
|
||||
return True
|
||||
self.set_value_explicit(value, self._data_type)
|
||||
|
||||
def _get_value(self):
|
||||
"""Return the value, formatted as a date if needed"""
|
||||
value = self._value
|
||||
if self.is_date():
|
||||
value = SharedDate().from_julian(value)
|
||||
return value
|
||||
|
||||
def _set_value(self, value):
|
||||
"""Set the value and infer type and display options."""
|
||||
self.bind_value(value)
|
||||
|
||||
value = property(_get_value, _set_value,
|
||||
doc = 'Get or set the value held in the cell.\n\n'
|
||||
':rtype: depends on the value (string, float, int or '
|
||||
':class:`datetime.datetime`)')
|
||||
|
||||
def _set_hyperlink(self, val):
|
||||
"""Set value and display for hyperlinks in a cell"""
|
||||
if self._hyperlink_rel is None:
|
||||
self._hyperlink_rel = self.parent.create_relationship("hyperlink")
|
||||
self._hyperlink_rel.target = val
|
||||
self._hyperlink_rel.target_mode = "External"
|
||||
if self._value is None:
|
||||
self.value = val
|
||||
|
||||
def _get_hyperlink(self):
|
||||
"""Return the hyperlink target or an empty string"""
|
||||
return self._hyperlink_rel is not None and \
|
||||
self._hyperlink_rel.target or ''
|
||||
|
||||
hyperlink = property(_get_hyperlink, _set_hyperlink,
|
||||
doc = 'Get or set the hyperlink held in the cell. '
|
||||
'Automatically sets the `value` of the cell with link text, '
|
||||
'but you can modify it afterwards by setting the '
|
||||
'`value` property, and the hyperlink will remain.\n\n'
|
||||
':rtype: string')
|
||||
|
||||
@property
|
||||
def hyperlink_rel_id(self):
|
||||
"""Return the id pointed to by the hyperlink, or None"""
|
||||
return self._hyperlink_rel is not None and \
|
||||
self._hyperlink_rel.id or None
|
||||
|
||||
def _set_number_format(self, format_code):
|
||||
"""Set a new formatting code for numeric values"""
|
||||
self.style.number_format.format_code = format_code
|
||||
|
||||
@property
|
||||
def has_style(self):
|
||||
"""Check if the parent worksheet has a style for this cell"""
|
||||
return self.get_coordinate() in self.parent._styles #pylint: disable-msg=W0212
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""Returns the :class:`.style.Style` object for this cell"""
|
||||
return self.parent.get_style(self.get_coordinate())
|
||||
|
||||
@property
|
||||
def data_type(self):
|
||||
"""Return the data type represented by this cell"""
|
||||
return self._data_type
|
||||
|
||||
def get_coordinate(self):
|
||||
"""Return the coordinate string for this cell (e.g. 'B12')
|
||||
|
||||
:rtype: string
|
||||
"""
|
||||
return '%s%s' % (self.column, self.row)
|
||||
|
||||
@property
|
||||
def address(self):
|
||||
"""Return the coordinate string for this cell (e.g. 'B12')
|
||||
|
||||
:rtype: string
|
||||
"""
|
||||
return self.get_coordinate()
|
||||
|
||||
def offset(self, row = 0, column = 0):
|
||||
"""Returns a cell location relative to this cell.
|
||||
|
||||
:param row: number of rows to offset
|
||||
:type row: int
|
||||
|
||||
:param column: number of columns to offset
|
||||
:type column: int
|
||||
|
||||
:rtype: :class:`.cell.Cell`
|
||||
"""
|
||||
offset_column = get_column_letter(column_index_from_string(
|
||||
column = self.column) + column)
|
||||
offset_row = self.row + row
|
||||
return self.parent.cell('%s%s' % (offset_column, offset_row))
|
||||
|
||||
def is_date(self):
|
||||
"""Returns whether the value is *probably* a date or not
|
||||
|
||||
:rtype: bool
|
||||
"""
|
||||
return (self.has_style
|
||||
and self.style.number_format.is_date_format()
|
||||
and isinstance(self._value, (int, float)))
|
||||
@@ -0,0 +1,340 @@
|
||||
'''
|
||||
Copyright (c) 2010 openpyxl
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@license: http://www.opensource.org/licenses/mit-license.php
|
||||
@author: Eric Gazoni
|
||||
'''
|
||||
|
||||
import math
|
||||
|
||||
from .style import NumberFormat
|
||||
from .drawing import Drawing, Shape
|
||||
from .shared.units import pixels_to_EMU, short_color
|
||||
from .cell import get_column_letter
|
||||
|
||||
class Axis(object):
|
||||
|
||||
POSITION_BOTTOM = 'b'
|
||||
POSITION_LEFT = 'l'
|
||||
|
||||
ORIENTATION_MIN_MAX = "minMax"
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.orientation = self.ORIENTATION_MIN_MAX
|
||||
self.number_format = NumberFormat()
|
||||
for attr in ('position','tick_label_position','crosses',
|
||||
'auto','label_align','label_offset','cross_between'):
|
||||
setattr(self, attr, None)
|
||||
self.min = 0
|
||||
self.max = None
|
||||
self.unit = None
|
||||
|
||||
@classmethod
|
||||
def default_category(cls):
|
||||
""" default values for category axes """
|
||||
|
||||
ax = Axis()
|
||||
ax.id = 60871424
|
||||
ax.cross = 60873344
|
||||
ax.position = Axis.POSITION_BOTTOM
|
||||
ax.tick_label_position = 'nextTo'
|
||||
ax.crosses = "autoZero"
|
||||
ax.auto = True
|
||||
ax.label_align = 'ctr'
|
||||
ax.label_offset = 100
|
||||
return ax
|
||||
|
||||
@classmethod
|
||||
def default_value(cls):
|
||||
""" default values for value axes """
|
||||
|
||||
ax = Axis()
|
||||
ax.id = 60873344
|
||||
ax.cross = 60871424
|
||||
ax.position = Axis.POSITION_LEFT
|
||||
ax.major_gridlines = None
|
||||
ax.tick_label_position = 'nextTo'
|
||||
ax.crosses = 'autoZero'
|
||||
ax.auto = False
|
||||
ax.cross_between = 'between'
|
||||
return ax
|
||||
|
||||
class Reference(object):
|
||||
""" a simple wrapper around a serie of reference data """
|
||||
|
||||
def __init__(self, sheet, pos1, pos2=None):
|
||||
|
||||
self.sheet = sheet
|
||||
self.pos1 = pos1
|
||||
self.pos2 = pos2
|
||||
|
||||
def get_type(self):
|
||||
|
||||
if isinstance(self.cache[0], str):
|
||||
return 'str'
|
||||
else:
|
||||
return 'num'
|
||||
|
||||
def _get_ref(self):
|
||||
""" format excel reference notation """
|
||||
|
||||
if self.pos2:
|
||||
return '%s!$%s$%s:$%s$%s' % (self.sheet.title,
|
||||
get_column_letter(self.pos1[1]+1), self.pos1[0]+1,
|
||||
get_column_letter(self.pos2[1]+1), self.pos2[0]+1)
|
||||
else:
|
||||
return '%s!$%s$%s' % (self.sheet.title,
|
||||
get_column_letter(self.pos1[1]+1), self.pos1[0]+1)
|
||||
|
||||
|
||||
def _get_cache(self):
|
||||
""" read data in sheet - to be used at writing time """
|
||||
|
||||
cache = []
|
||||
if self.pos2:
|
||||
for row in range(self.pos1[0], self.pos2[0]+1):
|
||||
for col in range(self.pos1[1], self.pos2[1]+1):
|
||||
cache.append(self.sheet.cell(row=row, column=col).value)
|
||||
else:
|
||||
cell = self.sheet.cell(row=self.pos1[0], column=self.pos1[1])
|
||||
cache.append(cell.value)
|
||||
return cache
|
||||
|
||||
|
||||
class Serie(object):
|
||||
""" a serie of data and possibly associated labels """
|
||||
|
||||
MARKER_NONE = 'none'
|
||||
|
||||
def __init__(self, values, labels=None, legend=None, color=None, xvalues=None):
|
||||
|
||||
self.marker = Serie.MARKER_NONE
|
||||
self.values = values
|
||||
self.xvalues = xvalues
|
||||
self.labels = labels
|
||||
self.legend = legend
|
||||
self.error_bar = None
|
||||
self._color = color
|
||||
|
||||
def _get_color(self):
|
||||
return self._color
|
||||
|
||||
def _set_color(self, color):
|
||||
self._color = short_color(color)
|
||||
|
||||
color = property(_get_color, _set_color)
|
||||
|
||||
def get_min_max(self):
|
||||
|
||||
if self.error_bar:
|
||||
err_cache = self.error_bar.values._get_cache()
|
||||
vals = [v + err_cache[i] \
|
||||
for i,v in enumerate(self.values._get_cache())]
|
||||
else:
|
||||
vals = self.values._get_cache()
|
||||
return min(vals), max(vals)
|
||||
|
||||
def __len__(self):
|
||||
|
||||
return len(self.values.cache)
|
||||
|
||||
class Legend(object):
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.position = 'r'
|
||||
self.layout = None
|
||||
|
||||
class ErrorBar(object):
|
||||
|
||||
PLUS = 1
|
||||
MINUS = 2
|
||||
PLUS_MINUS = 3
|
||||
|
||||
def __init__(self, _type, values):
|
||||
|
||||
self.type = _type
|
||||
self.values = values
|
||||
|
||||
class Chart(object):
|
||||
""" raw chart class """
|
||||
|
||||
GROUPING_CLUSTERED = 'clustered'
|
||||
GROUPING_STANDARD = 'standard'
|
||||
|
||||
BAR_CHART = 1
|
||||
LINE_CHART = 2
|
||||
SCATTER_CHART = 3
|
||||
|
||||
def __init__(self, _type, grouping):
|
||||
|
||||
self._series = []
|
||||
|
||||
# public api
|
||||
self.type = _type
|
||||
self.grouping = grouping
|
||||
self.x_axis = Axis.default_category()
|
||||
self.y_axis = Axis.default_value()
|
||||
self.legend = Legend()
|
||||
self.lang = 'fr-FR'
|
||||
self.title = ''
|
||||
self.print_margins = dict(b=.75, l=.7, r=.7, t=.75, header=0.3, footer=.3)
|
||||
|
||||
# the containing drawing
|
||||
self.drawing = Drawing()
|
||||
|
||||
# the offset for the plot part in percentage of the drawing size
|
||||
self.width = .6
|
||||
self.height = .6
|
||||
self.margin_top = self._get_max_margin_top()
|
||||
self.margin_left = 0
|
||||
|
||||
# the user defined shapes
|
||||
self._shapes = []
|
||||
|
||||
def add_serie(self, serie):
|
||||
|
||||
serie.id = len(self._series)
|
||||
self._series.append(serie)
|
||||
self._compute_min_max()
|
||||
if not None in [s.xvalues for s in self._series]:
|
||||
self._compute_xmin_xmax()
|
||||
|
||||
def add_shape(self, shape):
|
||||
|
||||
shape._chart = self
|
||||
self._shapes.append(shape)
|
||||
|
||||
def get_x_units(self):
|
||||
""" calculate one unit for x axis in EMU """
|
||||
|
||||
return max([len(s.values._get_cache()) for s in self._series])
|
||||
|
||||
def get_y_units(self):
|
||||
""" calculate one unit for y axis in EMU """
|
||||
|
||||
dh = pixels_to_EMU(self.drawing.height)
|
||||
return (dh * self.height) / self.y_axis.max
|
||||
|
||||
def get_y_chars(self):
|
||||
""" estimate nb of chars for y axis """
|
||||
|
||||
_max = max([max(s.values._get_cache()) for s in self._series])
|
||||
return len(str(int(_max)))
|
||||
|
||||
def _compute_min_max(self):
|
||||
""" compute y axis limits and units """
|
||||
|
||||
maxi = max([max(s.values._get_cache()) for s in self._series])
|
||||
|
||||
mul = None
|
||||
if maxi < 1:
|
||||
s = str(maxi).split('.')[1]
|
||||
mul = 10
|
||||
for x in s:
|
||||
if x == '0':
|
||||
mul *= 10
|
||||
else:
|
||||
break
|
||||
maxi = maxi * mul
|
||||
|
||||
maxi = math.ceil(maxi * 1.1)
|
||||
sz = len(str(int(maxi))) - 1
|
||||
unit = math.ceil(math.ceil(maxi / pow(10, sz)) * pow(10, sz-1))
|
||||
maxi = math.ceil(maxi/unit) * unit
|
||||
|
||||
if mul is not None:
|
||||
maxi = maxi/mul
|
||||
unit = unit/mul
|
||||
|
||||
if maxi / unit > 9:
|
||||
# no more that 10 ticks
|
||||
unit *= 2
|
||||
|
||||
self.y_axis.max = maxi
|
||||
self.y_axis.unit = unit
|
||||
|
||||
def _compute_xmin_xmax(self):
|
||||
""" compute x axis limits and units """
|
||||
|
||||
maxi = max([max(s.xvalues._get_cache()) for s in self._series])
|
||||
|
||||
mul = None
|
||||
if maxi < 1:
|
||||
s = str(maxi).split('.')[1]
|
||||
mul = 10
|
||||
for x in s:
|
||||
if x == '0':
|
||||
mul *= 10
|
||||
else:
|
||||
break
|
||||
maxi = maxi * mul
|
||||
|
||||
maxi = math.ceil(maxi * 1.1)
|
||||
sz = len(str(int(maxi))) - 1
|
||||
unit = math.ceil(math.ceil(maxi / pow(10, sz)) * pow(10, sz-1))
|
||||
maxi = math.ceil(maxi/unit) * unit
|
||||
|
||||
if mul is not None:
|
||||
maxi = maxi/mul
|
||||
unit = unit/mul
|
||||
|
||||
if maxi / unit > 9:
|
||||
# no more that 10 ticks
|
||||
unit *= 2
|
||||
|
||||
self.x_axis.max = maxi
|
||||
self.x_axis.unit = unit
|
||||
|
||||
def _get_max_margin_top(self):
|
||||
|
||||
mb = Shape.FONT_HEIGHT + Shape.MARGIN_BOTTOM
|
||||
plot_height = self.drawing.height * self.height
|
||||
return float(self.drawing.height - plot_height - mb)/self.drawing.height
|
||||
|
||||
def _get_min_margin_left(self):
|
||||
|
||||
ml = (self.get_y_chars() * Shape.FONT_WIDTH) + Shape.MARGIN_LEFT
|
||||
return float(ml)/self.drawing.width
|
||||
|
||||
def _get_margin_top(self):
|
||||
""" get margin in percent """
|
||||
|
||||
return min(self.margin_top, self._get_max_margin_top())
|
||||
|
||||
def _get_margin_left(self):
|
||||
|
||||
return max(self._get_min_margin_left(), self.margin_left)
|
||||
|
||||
class BarChart(Chart):
|
||||
def __init__(self):
|
||||
super(BarChart, self).__init__(Chart.BAR_CHART, Chart.GROUPING_CLUSTERED)
|
||||
|
||||
class LineChart(Chart):
|
||||
def __init__(self):
|
||||
super(LineChart, self).__init__(Chart.LINE_CHART, Chart.GROUPING_STANDARD)
|
||||
|
||||
class ScatterChart(Chart):
|
||||
def __init__(self):
|
||||
super(ScatterChart, self).__init__(Chart.SCATTER_CHART, Chart.GROUPING_STANDARD)
|
||||
|
||||
|
||||
@@ -0,0 +1,402 @@
|
||||
'''
|
||||
Copyright (c) 2010 openpyxl
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
@license: http://www.opensource.org/licenses/mit-license.php
|
||||
@author: Eric Gazoni
|
||||
'''
|
||||
|
||||
import math
|
||||
from .style import Color
|
||||
from .shared.units import pixels_to_EMU, EMU_to_pixels, short_color
|
||||
|
||||
class Shadow(object):
|
||||
|
||||
SHADOW_BOTTOM = 'b'
|
||||
SHADOW_BOTTOM_LEFT = 'bl'
|
||||
SHADOW_BOTTOM_RIGHT = 'br'
|
||||
SHADOW_CENTER = 'ctr'
|
||||
SHADOW_LEFT = 'l'
|
||||
SHADOW_TOP = 't'
|
||||
SHADOW_TOP_LEFT = 'tl'
|
||||
SHADOW_TOP_RIGHT = 'tr'
|
||||
|
||||
def __init__(self):
|
||||
self.visible = False
|
||||
self.blurRadius = 6
|
||||
self.distance = 2
|
||||
self.direction = 0
|
||||
self.alignment = self.SHADOW_BOTTOM_RIGHT
|
||||
self.color = Color(Color.BLACK)
|
||||
self.alpha = 50
|
||||
|
||||
class Drawing(object):
|
||||
""" a drawing object - eg container for shapes or charts
|
||||
we assume user specifies dimensions in pixels; units are
|
||||
converted to EMU in the drawing part
|
||||
"""
|
||||
|
||||
count = 0
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.name = ''
|
||||
self.description = ''
|
||||
self.coordinates = ((1,2), (16,8))
|
||||
self.left = 0
|
||||
self.top = 0
|
||||
self._width = EMU_to_pixels(200000)
|
||||
self._height = EMU_to_pixels(1828800)
|
||||
self.resize_proportional = False
|
||||
self.rotation = 0
|
||||
# self.shadow = Shadow()
|
||||
|
||||
def _set_width(self, w):
|
||||
|
||||
if self.resize_proportional and w:
|
||||
ratio = self._height / self._width
|
||||
self._height = round(ratio * w)
|
||||
self._width = w
|
||||
|
||||
def _get_width(self):
|
||||
|
||||
return self._width
|
||||
|
||||
width = property(_get_width, _set_width)
|
||||
|
||||
def _set_height(self, h):
|
||||
|
||||
if self.resize_proportional and h:
|
||||
ratio = self._width / self._height
|
||||
self._width = round(ratio * h)
|
||||
self._height = h
|
||||
|
||||
def _get_height(self):
|
||||
|
||||
return self._height
|
||||
|
||||
height = property(_get_height, _set_height)
|
||||
|
||||
def set_dimension(self, w=0, h=0):
|
||||
|
||||
xratio = w / self._width
|
||||
yratio = h / self._height
|
||||
|
||||
if self.resize_proportional and w and h:
|
||||
if (xratio * self._height) < h:
|
||||
self._height = math.ceil(xratio * self._height)
|
||||
self._width = width
|
||||
else:
|
||||
self._width = math.ceil(yratio * self._width)
|
||||
self._height = height
|
||||
|
||||
def get_emu_dimensions(self):
|
||||
""" return (x, y, w, h) in EMU """
|
||||
|
||||
return (pixels_to_EMU(self.left), pixels_to_EMU(self.top),
|
||||
pixels_to_EMU(self._width), pixels_to_EMU(self._height))
|
||||
|
||||
|
||||
class Shape(object):
|
||||
""" a drawing inside a chart
|
||||
coordiantes are specified by the user in the axis units
|
||||
"""
|
||||
|
||||
MARGIN_LEFT = 6 + 13 + 1
|
||||
MARGIN_BOTTOM = 17 + 11
|
||||
|
||||
FONT_WIDTH = 7
|
||||
FONT_HEIGHT = 8
|
||||
|
||||
ROUND_RECT = 'roundRect'
|
||||
RECT = 'rect'
|
||||
|
||||
# other shapes to define :
|
||||
'''
|
||||
"line"
|
||||
"lineInv"
|
||||
"triangle"
|
||||
"rtTriangle"
|
||||
"diamond"
|
||||
"parallelogram"
|
||||
"trapezoid"
|
||||
"nonIsoscelesTrapezoid"
|
||||
"pentagon"
|
||||
"hexagon"
|
||||
"heptagon"
|
||||
"octagon"
|
||||
"decagon"
|
||||
"dodecagon"
|
||||
"star4"
|
||||
"star5"
|
||||
"star6"
|
||||
"star7"
|
||||
"star8"
|
||||
"star10"
|
||||
"star12"
|
||||
"star16"
|
||||
"star24"
|
||||
"star32"
|
||||
"roundRect"
|
||||
"round1Rect"
|
||||
"round2SameRect"
|
||||
"round2DiagRect"
|
||||
"snipRoundRect"
|
||||
"snip1Rect"
|
||||
"snip2SameRect"
|
||||
"snip2DiagRect"
|
||||
"plaque"
|
||||
"ellipse"
|
||||
"teardrop"
|
||||
"homePlate"
|
||||
"chevron"
|
||||
"pieWedge"
|
||||
"pie"
|
||||
"blockArc"
|
||||
"donut"
|
||||
"noSmoking"
|
||||
"rightArrow"
|
||||
"leftArrow"
|
||||
"upArrow"
|
||||
"downArrow"
|
||||
"stripedRightArrow"
|
||||
"notchedRightArrow"
|
||||
"bentUpArrow"
|
||||
"leftRightArrow"
|
||||
"upDownArrow"
|
||||
"leftUpArrow"
|
||||
"leftRightUpArrow"
|
||||
"quadArrow"
|
||||
"leftArrowCallout"
|
||||
"rightArrowCallout"
|
||||
"upArrowCallout"
|
||||
"downArrowCallout"
|
||||
"leftRightArrowCallout"
|
||||
"upDownArrowCallout"
|
||||
"quadArrowCallout"
|
||||
"bentArrow"
|
||||
"uturnArrow"
|
||||
"circularArrow"
|
||||
"leftCircularArrow"
|
||||
"leftRightCircularArrow"
|
||||
"curvedRightArrow"
|
||||
"curvedLeftArrow"
|
||||
"curvedUpArrow"
|
||||
"curvedDownArrow"
|
||||
"swooshArrow"
|
||||
"cube"
|
||||
"can"
|
||||
"lightningBolt"
|
||||
"heart"
|
||||
"sun"
|
||||
"moon"
|
||||
"smileyFace"
|
||||
"irregularSeal1"
|
||||
"irregularSeal2"
|
||||
"foldedCorner"
|
||||
"bevel"
|
||||
"frame"
|
||||
"halfFrame"
|
||||
"corner"
|
||||
"diagStripe"
|
||||
"chord"
|
||||
"arc"
|
||||
"leftBracket"
|
||||
"rightBracket"
|
||||
"leftBrace"
|
||||
"rightBrace"
|
||||
"bracketPair"
|
||||
"bracePair"
|
||||
"straightConnector1"
|
||||
"bentConnector2"
|
||||
"bentConnector3"
|
||||
"bentConnector4"
|
||||
"bentConnector5"
|
||||
"curvedConnector2"
|
||||
"curvedConnector3"
|
||||
"curvedConnector4"
|
||||
"curvedConnector5"
|
||||
"callout1"
|
||||
"callout2"
|
||||
"callout3"
|
||||
"accentCallout1"
|
||||
"accentCallout2"
|
||||
"accentCallout3"
|
||||
"borderCallout1"
|
||||
"borderCallout2"
|
||||
"borderCallout3"
|
||||
"accentBorderCallout1"
|
||||
"accentBorderCallout2"
|
||||
"accentBorderCallout3"
|
||||
"wedgeRectCallout"
|
||||
"wedgeRoundRectCallout"
|
||||
"wedgeEllipseCallout"
|
||||
"cloudCallout"
|
||||
"cloud"
|
||||
"ribbon"
|
||||
"ribbon2"
|
||||
"ellipseRibbon"
|
||||
"ellipseRibbon2"
|
||||
"leftRightRibbon"
|
||||
"verticalScroll"
|
||||
"horizontalScroll"
|
||||
"wave"
|
||||
"doubleWave"
|
||||
"plus"
|
||||
"flowChartProcess"
|
||||
"flowChartDecision"
|
||||
"flowChartInputOutput"
|
||||
"flowChartPredefinedProcess"
|
||||
"flowChartInternalStorage"
|
||||
"flowChartDocument"
|
||||
"flowChartMultidocument"
|
||||
"flowChartTerminator"
|
||||
"flowChartPreparation"
|
||||
"flowChartManualInput"
|
||||
"flowChartManualOperation"
|
||||
"flowChartConnector"
|
||||
"flowChartPunchedCard"
|
||||
"flowChartPunchedTape"
|
||||
"flowChartSummingJunction"
|
||||
"flowChartOr"
|
||||
"flowChartCollate"
|
||||
"flowChartSort"
|
||||
"flowChartExtract"
|
||||
"flowChartMerge"
|
||||
"flowChartOfflineStorage"
|
||||
"flowChartOnlineStorage"
|
||||
"flowChartMagneticTape"
|
||||
"flowChartMagneticDisk"
|
||||
"flowChartMagneticDrum"
|
||||
"flowChartDisplay"
|
||||
"flowChartDelay"
|
||||
"flowChartAlternateProcess"
|
||||
"flowChartOffpageConnector"
|
||||
"actionButtonBlank"
|
||||
"actionButtonHome"
|
||||
"actionButtonHelp"
|
||||
"actionButtonInformation"
|
||||
"actionButtonForwardNext"
|
||||
"actionButtonBackPrevious"
|
||||
"actionButtonEnd"
|
||||
"actionButtonBeginning"
|
||||
"actionButtonReturn"
|
||||
"actionButtonDocument"
|
||||
"actionButtonSound"
|
||||
"actionButtonMovie"
|
||||
"gear6"
|
||||
"gear9"
|
||||
"funnel"
|
||||
"mathPlus"
|
||||
"mathMinus"
|
||||
"mathMultiply"
|
||||
"mathDivide"
|
||||
"mathEqual"
|
||||
"mathNotEqual"
|
||||
"cornerTabs"
|
||||
"squareTabs"
|
||||
"plaqueTabs"
|
||||
"chartX"
|
||||
"chartStar"
|
||||
"chartPlus"
|
||||
'''
|
||||
|
||||
def __init__(self, coordinates=((0,0), (1,1)), text=None, scheme="accent1"):
|
||||
|
||||
self.coordinates = coordinates # in axis unit
|
||||
self.text = text
|
||||
self.scheme = scheme
|
||||
self.style = Shape.RECT
|
||||
self._border_width = 3175 # in EMU
|
||||
self._border_color = Color.BLACK[2:] #"F3B3C5"
|
||||
self._color = Color.WHITE[2:]
|
||||
self._text_color = Color.BLACK[2:]
|
||||
|
||||
def _get_border_color(self):
|
||||
return self._border_color
|
||||
|
||||
def _set_border_color(self, color):
|
||||
self._border_color = short_color(color)
|
||||
|
||||
border_color = property(_get_border_color, _set_border_color)
|
||||
|
||||
def _get_color(self):
|
||||
return self._color
|
||||
|
||||
def _set_color(self, color):
|
||||
self._color = short_color(color)
|
||||
|
||||
color = property(_get_color, _set_color)
|
||||
|
||||
def _get_text_color(self):
|
||||
return self._text_color
|
||||
|
||||
def _set_text_color(self, color):
|
||||
self._text_color = short_color(color)
|
||||
|
||||
text_color = property(_get_text_color, _set_text_color)
|
||||
|
||||
def _get_border_width(self):
|
||||
|
||||
return EMU_to_pixels(self._border_width)
|
||||
|
||||
def _set_border_width(self, w):
|
||||
|
||||
self._border_width = pixels_to_EMU(w)
|
||||
print(self._border_width)
|
||||
|
||||
border_width = property(_get_border_width, _set_border_width)
|
||||
|
||||
def get_coordinates(self):
|
||||
""" return shape coordinates in percentages (left, top, right, bottom) """
|
||||
|
||||
(x1, y1), (x2, y2) = self.coordinates
|
||||
|
||||
drawing_width = pixels_to_EMU(self._chart.drawing.width)
|
||||
drawing_height = pixels_to_EMU(self._chart.drawing.height)
|
||||
plot_width = drawing_width * self._chart.width
|
||||
plot_height = drawing_height * self._chart.height
|
||||
|
||||
margin_left = self._chart._get_margin_left() * drawing_width
|
||||
xunit = plot_width / self._chart.get_x_units()
|
||||
|
||||
margin_top = self._chart._get_margin_top() * drawing_height
|
||||
yunit = self._chart.get_y_units()
|
||||
|
||||
x_start = (margin_left + (float(x1) * xunit)) / drawing_width
|
||||
y_start = (margin_top + plot_height - (float(y1) * yunit)) / drawing_height
|
||||
|
||||
x_end = (margin_left + (float(x2) * xunit)) / drawing_width
|
||||
y_end = (margin_top + plot_height - (float(y2) * yunit)) / drawing_height
|
||||
|
||||
def _norm_pct(pct):
|
||||
""" force shapes to appear by truncating too large sizes """
|
||||
if pct>1: pct = 1
|
||||
elif pct<0: pct = 0
|
||||
return pct
|
||||
|
||||
# allow user to specify y's in whatever order
|
||||
# excel expect y_end to be lower
|
||||
if y_end < y_start:
|
||||
y_end, y_start = y_start, y_end
|
||||
|
||||
return (_norm_pct(x_start), _norm_pct(y_start),
|
||||
_norm_pct(x_end), _norm_pct(y_end))
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
# file openpyxl/namedrange.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Track named groups of cells in a worksheet"""
|
||||
|
||||
# Python stdlib imports
|
||||
import re
|
||||
|
||||
# package imports
|
||||
from .shared.exc import NamedRangeException
|
||||
|
||||
# constants
|
||||
NAMED_RANGE_RE = re.compile("'?([^']*)'?!((\$([A-Za-z]+))?\$([0-9]+)(:(\$([A-Za-z]+))?(\$([0-9]+)))?)$")
|
||||
|
||||
class NamedRange(object):
|
||||
"""A named group of cells"""
|
||||
__slots__ = ('name', 'destinations', 'local_only')
|
||||
|
||||
def __init__(self, name, destinations):
|
||||
self.name = name
|
||||
self.destinations = destinations
|
||||
self.local_only = False
|
||||
|
||||
def __str__(self):
|
||||
return ','.join(['%s!%s' % (sheet, name) for sheet, name in self.destinations])
|
||||
|
||||
def __repr__(self):
|
||||
|
||||
return '<%s "%s">' % (self.__class__.__name__, str(self))
|
||||
|
||||
|
||||
def split_named_range(range_string):
|
||||
"""Separate a named range into its component parts"""
|
||||
|
||||
destinations = []
|
||||
|
||||
for range_string in range_string.split(','):
|
||||
|
||||
match = NAMED_RANGE_RE.match(range_string)
|
||||
if not match:
|
||||
raise NamedRangeException('Invalid named range string: "%s"' % range_string)
|
||||
else:
|
||||
sheet_name, xlrange = match.groups()[:2]
|
||||
destinations.append((sheet_name, xlrange))
|
||||
|
||||
return destinations
|
||||
@@ -0,0 +1,33 @@
|
||||
# file openpyxl/reader/__init__.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Imports for the openpyxl.reader namespace."""
|
||||
|
||||
# package imports
|
||||
from . import excel
|
||||
from . import strings
|
||||
from . import style
|
||||
from . import workbook
|
||||
from . import worksheet
|
||||
@@ -0,0 +1,117 @@
|
||||
# file openpyxl/reader/excel.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read an xlsx file into Python"""
|
||||
|
||||
# Python stdlib imports
|
||||
from zipfile import ZipFile, ZIP_DEFLATED, BadZipfile
|
||||
|
||||
# package imports
|
||||
from ..shared.exc import OpenModeError, InvalidFileException
|
||||
from ..shared.ooxml import ARC_SHARED_STRINGS, ARC_CORE, ARC_APP, \
|
||||
ARC_WORKBOOK, PACKAGE_WORKSHEETS, ARC_STYLE
|
||||
from ..workbook import Workbook
|
||||
from .strings import read_string_table
|
||||
from .style import read_style_table
|
||||
from .workbook import read_sheets_titles, read_named_ranges, \
|
||||
read_properties_core, get_sheet_ids
|
||||
from .worksheet import read_worksheet
|
||||
from .iter_worksheet import unpack_worksheet
|
||||
|
||||
def load_workbook(filename, use_iterators = False):
|
||||
"""Open the given filename and return the workbook
|
||||
|
||||
:param filename: the path to open
|
||||
:type filename: string
|
||||
|
||||
:param use_iterators: use lazy load for cells
|
||||
:type use_iterators: bool
|
||||
|
||||
:rtype: :class:`..workbook.Workbook`
|
||||
|
||||
.. note::
|
||||
|
||||
When using lazy load, all worksheets will be :class:`.iter_worksheet.IterableWorksheet`
|
||||
and the returned workbook will be read-only.
|
||||
|
||||
"""
|
||||
|
||||
if isinstance(filename, file):
|
||||
# fileobject must have been opened with 'rb' flag
|
||||
# it is required by zipfile
|
||||
if 'b' not in filename.mode:
|
||||
raise OpenModeError("File-object must be opened in binary mode")
|
||||
|
||||
try:
|
||||
archive = ZipFile(filename, 'r', ZIP_DEFLATED)
|
||||
except (BadZipfile, RuntimeError, IOError, ValueError) as e:
|
||||
raise InvalidFileException(str(e))
|
||||
wb = Workbook()
|
||||
|
||||
if use_iterators:
|
||||
wb._set_optimized_read()
|
||||
|
||||
try:
|
||||
_load_workbook(wb, archive, filename, use_iterators)
|
||||
except KeyError as e:
|
||||
raise InvalidFileException(str(e))
|
||||
except Exception as e:
|
||||
raise e
|
||||
finally:
|
||||
archive.close()
|
||||
return wb
|
||||
|
||||
def _load_workbook(wb, archive, filename, use_iterators):
|
||||
|
||||
valid_files = archive.namelist()
|
||||
|
||||
# get workbook-level information
|
||||
wb.properties = read_properties_core(archive.read(ARC_CORE))
|
||||
try:
|
||||
string_table = read_string_table(archive.read(ARC_SHARED_STRINGS))
|
||||
except KeyError:
|
||||
string_table = {}
|
||||
style_table = read_style_table(archive.read(ARC_STYLE))
|
||||
|
||||
# get worksheets
|
||||
wb.worksheets = [] # remove preset worksheet
|
||||
sheet_names = read_sheets_titles(archive.read(ARC_APP))
|
||||
for i, sheet_name in enumerate(sheet_names):
|
||||
|
||||
sheet_codename = 'sheet%d.xml' % (i + 1)
|
||||
worksheet_path = '%s/%s' % (PACKAGE_WORKSHEETS, sheet_codename)
|
||||
|
||||
if not worksheet_path in valid_files:
|
||||
continue
|
||||
|
||||
if not use_iterators:
|
||||
new_ws = read_worksheet(archive.read(worksheet_path), wb, sheet_name, string_table, style_table)
|
||||
else:
|
||||
xml_source = unpack_worksheet(archive, worksheet_path)
|
||||
new_ws = read_worksheet(xml_source, wb, sheet_name, string_table, style_table, filename, sheet_codename)
|
||||
#new_ws = read_worksheet(archive.read(worksheet_path), wb, sheet_name, string_table, style_table, filename, sheet_codename)
|
||||
wb.add_sheet(new_ws, index = i)
|
||||
|
||||
wb._named_ranges = read_named_ranges(archive.read(ARC_WORKBOOK), wb)
|
||||
@@ -0,0 +1,343 @@
|
||||
# file openpyxl/reader/iter_worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
""" Iterators-based worksheet reader
|
||||
*Still very raw*
|
||||
"""
|
||||
|
||||
from io import StringIO
|
||||
import warnings
|
||||
import operator
|
||||
from functools import partial
|
||||
from itertools import groupby
|
||||
from ..worksheet import Worksheet
|
||||
from ..cell import coordinate_from_string, get_column_letter, Cell
|
||||
from .excel import get_sheet_ids
|
||||
from .strings import read_string_table
|
||||
from .style import read_style_table, NumberFormat
|
||||
from ..shared.date_time import SharedDate
|
||||
from .worksheet import read_dimension
|
||||
from ..shared.ooxml import (MIN_COLUMN, MAX_COLUMN, PACKAGE_WORKSHEETS,
|
||||
MAX_ROW, MIN_ROW, ARC_SHARED_STRINGS, ARC_APP, ARC_STYLE)
|
||||
from xml.etree.cElementTree import iterparse
|
||||
from zipfile import ZipFile
|
||||
from .. import cell
|
||||
import re
|
||||
import tempfile
|
||||
import zlib
|
||||
import zipfile
|
||||
import struct
|
||||
|
||||
TYPE_NULL = Cell.TYPE_NULL
|
||||
MISSING_VALUE = None
|
||||
|
||||
RE_COORDINATE = re.compile('^([A-Z]+)([0-9]+)$')
|
||||
|
||||
SHARED_DATE = SharedDate()
|
||||
|
||||
_COL_CONVERSION_CACHE = dict((get_column_letter(i), i) for i in range(1, 18279))
|
||||
def column_index_from_string(str_col, _col_conversion_cache=_COL_CONVERSION_CACHE):
|
||||
# we use a function argument to get indexed name lookup
|
||||
return _col_conversion_cache[str_col]
|
||||
del _COL_CONVERSION_CACHE
|
||||
|
||||
RAW_ATTRIBUTES = ['row', 'column', 'coordinate', 'internal_value', 'data_type', 'style_id', 'number_format']
|
||||
|
||||
try:
|
||||
from collections import namedtuple
|
||||
BaseRawCell = namedtuple('RawCell', RAW_ATTRIBUTES)
|
||||
except ImportError:
|
||||
|
||||
warnings.warn("""Unable to import 'namedtuple' module, this may cause memory issues when using optimized reader. Please upgrade your Python installation to 2.6+""")
|
||||
|
||||
class BaseRawCell(object):
|
||||
|
||||
def __init__(self, *args):
|
||||
assert len(args)==len(RAW_ATTRIBUTES)
|
||||
|
||||
for attr, val in zip(RAW_ATTRIBUTES, args):
|
||||
setattr(self, attr, val)
|
||||
|
||||
def _replace(self, **kwargs):
|
||||
|
||||
self.__dict__.update(kwargs)
|
||||
|
||||
return self
|
||||
|
||||
|
||||
class RawCell(BaseRawCell):
|
||||
"""Optimized version of the :class:`..cell.Cell`, using named tuples.
|
||||
|
||||
Useful attributes are:
|
||||
|
||||
* row
|
||||
* column
|
||||
* coordinate
|
||||
* internal_value
|
||||
|
||||
You can also access if needed:
|
||||
|
||||
* data_type
|
||||
* number_format
|
||||
|
||||
"""
|
||||
|
||||
@property
|
||||
def is_date(self):
|
||||
res = (self.data_type == Cell.TYPE_NUMERIC
|
||||
and self.number_format is not None
|
||||
and ('d' in self.number_format
|
||||
or 'm' in self.number_format
|
||||
or 'y' in self.number_format
|
||||
or 'h' in self.number_format
|
||||
or 's' in self.number_format
|
||||
))
|
||||
|
||||
return res
|
||||
|
||||
def iter_rows(workbook_name, sheet_name, xml_source, range_string = '', row_offset = 0, column_offset = 0):
|
||||
|
||||
archive = get_archive_file(workbook_name)
|
||||
|
||||
source = xml_source
|
||||
|
||||
if range_string:
|
||||
min_col, min_row, max_col, max_row = get_range_boundaries(range_string, row_offset, column_offset)
|
||||
else:
|
||||
min_col, min_row, max_col, max_row = read_dimension(xml_source = source)
|
||||
min_col = column_index_from_string(min_col)
|
||||
max_col = column_index_from_string(max_col) + 1
|
||||
max_row += 6
|
||||
|
||||
try:
|
||||
string_table = read_string_table(archive.read(ARC_SHARED_STRINGS))
|
||||
except KeyError:
|
||||
string_table = {}
|
||||
|
||||
style_table = read_style_table(archive.read(ARC_STYLE))
|
||||
|
||||
source.seek(0)
|
||||
p = iterparse(source)
|
||||
|
||||
return get_squared_range(p, min_col, min_row, max_col, max_row, string_table, style_table)
|
||||
|
||||
|
||||
def get_rows(p, min_column = MIN_COLUMN, min_row = MIN_ROW, max_column = MAX_COLUMN, max_row = MAX_ROW):
|
||||
|
||||
return groupby(get_cells(p, min_row, min_column, max_row, max_column), operator.attrgetter('row'))
|
||||
|
||||
def get_cells(p, min_row, min_col, max_row, max_col, _re_coordinate=RE_COORDINATE):
|
||||
|
||||
for _event, element in p:
|
||||
|
||||
if element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}c':
|
||||
coord = element.get('r')
|
||||
column_str, row = _re_coordinate.match(coord).groups()
|
||||
|
||||
row = int(row)
|
||||
column = column_index_from_string(column_str)
|
||||
|
||||
if min_col <= column <= max_col and min_row <= row <= max_row:
|
||||
data_type = element.get('t', 'n')
|
||||
style_id = element.get('s')
|
||||
value = element.findtext('{http://schemas.openxmlformats.org/spreadsheetml/2006/main}v')
|
||||
yield RawCell(row, column_str, coord, value, data_type, style_id, None)
|
||||
|
||||
if element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}v':
|
||||
continue
|
||||
element.clear()
|
||||
|
||||
|
||||
|
||||
def get_range_boundaries(range_string, row = 0, column = 0):
|
||||
|
||||
if ':' in range_string:
|
||||
min_range, max_range = range_string.split(':')
|
||||
min_col, min_row = coordinate_from_string(min_range)
|
||||
max_col, max_row = coordinate_from_string(max_range)
|
||||
|
||||
min_col = column_index_from_string(min_col) + column
|
||||
max_col = column_index_from_string(max_col) + column
|
||||
min_row += row
|
||||
max_row += row
|
||||
|
||||
else:
|
||||
min_col, min_row = coordinate_from_string(range_string)
|
||||
min_col = column_index_from_string(min_col)
|
||||
max_col = min_col + 1
|
||||
max_row = min_row
|
||||
|
||||
return (min_col, min_row, max_col, max_row)
|
||||
|
||||
def get_archive_file(archive_name):
|
||||
|
||||
return ZipFile(archive_name, 'r')
|
||||
|
||||
def get_xml_source(archive_file, sheet_name):
|
||||
|
||||
return archive_file.read('%s/%s' % (PACKAGE_WORKSHEETS, sheet_name))
|
||||
|
||||
def get_missing_cells(row, columns):
|
||||
|
||||
return dict([(column, RawCell(row, column, '%s%s' % (column, row), MISSING_VALUE, TYPE_NULL, None, None)) for column in columns])
|
||||
|
||||
def get_squared_range(p, min_col, min_row, max_col, max_row, string_table, style_table):
|
||||
|
||||
expected_columns = [get_column_letter(ci) for ci in range(min_col, max_col)]
|
||||
|
||||
current_row = min_row
|
||||
for row, cells in get_rows(p, min_row = min_row, max_row = max_row, min_column = min_col, max_column = max_col):
|
||||
full_row = []
|
||||
if current_row < row:
|
||||
|
||||
for gap_row in range(current_row, row):
|
||||
|
||||
dummy_cells = get_missing_cells(gap_row, expected_columns)
|
||||
|
||||
yield tuple([dummy_cells[column] for column in expected_columns])
|
||||
|
||||
current_row = row
|
||||
|
||||
temp_cells = list(cells)
|
||||
|
||||
retrieved_columns = dict([(c.column, c) for c in temp_cells])
|
||||
|
||||
missing_columns = list(set(expected_columns) - set(retrieved_columns.keys()))
|
||||
|
||||
replacement_columns = get_missing_cells(row, missing_columns)
|
||||
|
||||
for column in expected_columns:
|
||||
|
||||
if column in retrieved_columns:
|
||||
cell = retrieved_columns[column]
|
||||
|
||||
if cell.style_id is not None:
|
||||
style = style_table[int(cell.style_id)]
|
||||
cell = cell._replace(number_format = style.number_format.format_code) #pylint: disable-msg=W0212
|
||||
if cell.internal_value is not None:
|
||||
if cell.data_type == Cell.TYPE_STRING:
|
||||
cell = cell._replace(internal_value = string_table[int(cell.internal_value)]) #pylint: disable-msg=W0212
|
||||
elif cell.data_type == Cell.TYPE_BOOL:
|
||||
cell = cell._replace(internal_value = cell.internal_value == 'True')
|
||||
elif cell.is_date:
|
||||
cell = cell._replace(internal_value = SHARED_DATE.from_julian(float(cell.internal_value)))
|
||||
elif cell.data_type == Cell.TYPE_NUMERIC:
|
||||
cell = cell._replace(internal_value = float(cell.internal_value))
|
||||
full_row.append(cell)
|
||||
|
||||
else:
|
||||
full_row.append(replacement_columns[column])
|
||||
|
||||
current_row = row + 1
|
||||
|
||||
yield tuple(full_row)
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
class IterableWorksheet(Worksheet):
|
||||
|
||||
def __init__(self, parent_workbook, title, workbook_name,
|
||||
sheet_codename, xml_source):
|
||||
|
||||
Worksheet.__init__(self, parent_workbook, title)
|
||||
self._workbook_name = workbook_name
|
||||
self._sheet_codename = sheet_codename
|
||||
self._xml_source = xml_source
|
||||
|
||||
def iter_rows(self, range_string = '', row_offset = 0, column_offset = 0):
|
||||
""" Returns a squared range based on the `range_string` parameter,
|
||||
using generators.
|
||||
|
||||
:param range_string: range of cells (e.g. 'A1:C4')
|
||||
:type range_string: string
|
||||
|
||||
:param row: row index of the cell (e.g. 4)
|
||||
:type row: int
|
||||
|
||||
:param column: column index of the cell (e.g. 3)
|
||||
:type column: int
|
||||
|
||||
:rtype: generator
|
||||
|
||||
"""
|
||||
|
||||
return iter_rows(workbook_name = self._workbook_name,
|
||||
sheet_name = self._sheet_codename,
|
||||
xml_source = self._xml_source,
|
||||
range_string = range_string,
|
||||
row_offset = row_offset,
|
||||
column_offset = column_offset)
|
||||
|
||||
def cell(self, *args, **kwargs):
|
||||
|
||||
raise NotImplementedError("use 'iter_rows()' instead")
|
||||
|
||||
def range(self, *args, **kwargs):
|
||||
|
||||
raise NotImplementedError("use 'iter_rows()' instead")
|
||||
|
||||
def unpack_worksheet(archive, filename):
|
||||
|
||||
temp_file = tempfile.TemporaryFile(mode='r+', prefix='openpyxl.', suffix='.unpack.temp')
|
||||
|
||||
zinfo = archive.getinfo(filename)
|
||||
|
||||
if zinfo.compress_type == zipfile.ZIP_STORED:
|
||||
decoder = None
|
||||
elif zinfo.compress_type == zipfile.ZIP_DEFLATED:
|
||||
decoder = zlib.decompressobj(-zlib.MAX_WBITS)
|
||||
else:
|
||||
raise zipfile.BadZipFile("Unrecognized compression method")
|
||||
|
||||
archive.fp.seek(_get_file_offset(archive, zinfo))
|
||||
bytes_to_read = zinfo.compress_size
|
||||
|
||||
while True:
|
||||
buff = archive.fp.read(min(bytes_to_read, 102400))
|
||||
if not buff:
|
||||
break
|
||||
bytes_to_read -= len(buff)
|
||||
if decoder:
|
||||
buff = decoder.decompress(buff)
|
||||
temp_file.write(buff)
|
||||
|
||||
if decoder:
|
||||
temp_file.write(decoder.decompress('Z'))
|
||||
|
||||
return temp_file
|
||||
|
||||
def _get_file_offset(archive, zinfo):
|
||||
|
||||
try:
|
||||
return zinfo.file_offset
|
||||
except AttributeError:
|
||||
# From http://stackoverflow.com/questions/3781261/how-to-simulate-zipfile-open-in-python-2-5
|
||||
|
||||
# Seek over the fixed size fields to the "file name length" field in
|
||||
# the file header (26 bytes). Unpack this and the "extra field length"
|
||||
# field ourselves as info.extra doesn't seem to be the correct length.
|
||||
archive.fp.seek(zinfo.header_offset + 26)
|
||||
file_name_len, extra_len = struct.unpack("<HH", archive.fp.read(4))
|
||||
return zinfo.header_offset + 30 + file_name_len + extra_len
|
||||
@@ -0,0 +1,64 @@
|
||||
# file openpyxl/reader/strings.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read the shared strings table."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, QName
|
||||
from ..shared.ooxml import NAMESPACES
|
||||
|
||||
|
||||
def read_string_table(xml_source):
|
||||
"""Read in all shared strings in the table"""
|
||||
table = {}
|
||||
xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
|
||||
root = fromstring(text=xml_source)
|
||||
string_index_nodes = root.findall(QName(xmlns, 'si').text)
|
||||
for index, string_index_node in enumerate(string_index_nodes):
|
||||
table[index] = get_string(xmlns, string_index_node)
|
||||
return table
|
||||
|
||||
|
||||
def get_string(xmlns, string_index_node):
|
||||
"""Read the contents of a specific string index"""
|
||||
rich_nodes = string_index_node.findall(QName(xmlns, 'r').text)
|
||||
if rich_nodes:
|
||||
reconstructed_text = []
|
||||
for rich_node in rich_nodes:
|
||||
partial_text = get_text(xmlns, rich_node)
|
||||
reconstructed_text.append(partial_text)
|
||||
return ''.join(reconstructed_text)
|
||||
else:
|
||||
return get_text(xmlns, string_index_node)
|
||||
|
||||
|
||||
def get_text(xmlns, rich_node):
|
||||
"""Read rich text, discarding formatting if not disallowed"""
|
||||
text_node = rich_node.find(QName(xmlns, 't').text)
|
||||
partial_text = text_node.text or ''
|
||||
|
||||
if text_node.get(QName(NAMESPACES['xml'], 'space').text) != 'preserve':
|
||||
partial_text = partial_text.strip()
|
||||
return str(partial_text)
|
||||
@@ -0,0 +1,69 @@
|
||||
# file openpyxl/reader/style.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read shared style definitions"""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, QName
|
||||
from ..shared.exc import MissingNumberFormat
|
||||
from ..style import Style, NumberFormat
|
||||
|
||||
|
||||
def read_style_table(xml_source):
|
||||
"""Read styles from the shared style table"""
|
||||
table = {}
|
||||
xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
|
||||
root = fromstring(xml_source)
|
||||
custom_num_formats = parse_custom_num_formats(root, xmlns)
|
||||
builtin_formats = NumberFormat._BUILTIN_FORMATS
|
||||
cell_xfs = root.find(QName(xmlns, 'cellXfs').text)
|
||||
cell_xfs_nodes = cell_xfs.findall(QName(xmlns, 'xf').text)
|
||||
for index, cell_xfs_node in enumerate(cell_xfs_nodes):
|
||||
new_style = Style()
|
||||
number_format_id = int(cell_xfs_node.get('numFmtId'))
|
||||
if number_format_id < 164:
|
||||
new_style.number_format.format_code = \
|
||||
builtin_formats.get(number_format_id, 'General')
|
||||
else:
|
||||
|
||||
if number_format_id in custom_num_formats:
|
||||
new_style.number_format.format_code = \
|
||||
custom_num_formats[number_format_id]
|
||||
else:
|
||||
raise MissingNumberFormat('%s' % number_format_id)
|
||||
table[index] = new_style
|
||||
return table
|
||||
|
||||
|
||||
def parse_custom_num_formats(root, xmlns):
|
||||
"""Read in custom numeric formatting rules from the shared style table"""
|
||||
custom_formats = {}
|
||||
num_fmts = root.find(QName(xmlns, 'numFmts').text)
|
||||
if num_fmts is not None:
|
||||
num_fmt_nodes = num_fmts.findall(QName(xmlns, 'numFmt').text)
|
||||
for num_fmt_node in num_fmt_nodes:
|
||||
custom_formats[int(num_fmt_node.get('numFmtId'))] = \
|
||||
num_fmt_node.get('formatCode')
|
||||
return custom_formats
|
||||
@@ -0,0 +1,156 @@
|
||||
# file openpyxl/reader/workbook.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Read in global settings to be maintained by the workbook object."""
|
||||
|
||||
# package imports
|
||||
from ..shared.xmltools import fromstring, QName
|
||||
from ..shared.ooxml import NAMESPACES
|
||||
from ..workbook import DocumentProperties
|
||||
from ..shared.date_time import W3CDTF_to_datetime
|
||||
from ..namedrange import NamedRange, split_named_range
|
||||
|
||||
import datetime
|
||||
|
||||
# constants
|
||||
BUGGY_NAMED_RANGES = ['NA()', '#REF!']
|
||||
DISCARDED_RANGES = ['Excel_BuiltIn', 'Print_Area']
|
||||
|
||||
def get_sheet_ids(xml_source):
|
||||
|
||||
sheet_names = read_sheets_titles(xml_source)
|
||||
|
||||
return dict((sheet, 'sheet%d.xml' % (i + 1)) for i, sheet in enumerate(sheet_names))
|
||||
|
||||
|
||||
def read_properties_core(xml_source):
|
||||
"""Read assorted file properties."""
|
||||
properties = DocumentProperties()
|
||||
root = fromstring(xml_source)
|
||||
creator_node = root.find(QName(NAMESPACES['dc'], 'creator').text)
|
||||
if creator_node is not None:
|
||||
properties.creator = creator_node.text
|
||||
else:
|
||||
properties.creator = ''
|
||||
last_modified_by_node = root.find(
|
||||
QName(NAMESPACES['cp'], 'lastModifiedBy').text)
|
||||
if last_modified_by_node is not None:
|
||||
properties.last_modified_by = last_modified_by_node.text
|
||||
else:
|
||||
properties.last_modified_by = ''
|
||||
|
||||
created_node = root.find(QName(NAMESPACES['dcterms'], 'created').text)
|
||||
if created_node is not None:
|
||||
properties.created = W3CDTF_to_datetime(created_node.text)
|
||||
else:
|
||||
properties.created = datetime.datetime.now()
|
||||
|
||||
modified_node = root.find(QName(NAMESPACES['dcterms'], 'modified').text)
|
||||
if modified_node is not None:
|
||||
properties.modified = W3CDTF_to_datetime(modified_node.text)
|
||||
else:
|
||||
properties.modified = properties.created
|
||||
|
||||
return properties
|
||||
|
||||
|
||||
def get_number_of_parts(xml_source):
|
||||
"""Get a list of contents of the workbook."""
|
||||
parts_size = {}
|
||||
parts_names = []
|
||||
root = fromstring(xml_source)
|
||||
heading_pairs = root.find(QName('http://schemas.openxmlformats.org/officeDocument/2006/extended-properties',
|
||||
'HeadingPairs').text)
|
||||
vector = heading_pairs.find(QName(NAMESPACES['vt'], 'vector').text)
|
||||
children = vector.getchildren()
|
||||
for child_id in range(0, len(children), 2):
|
||||
part_name = children[child_id].find(QName(NAMESPACES['vt'],
|
||||
'lpstr').text).text
|
||||
if not part_name in parts_names:
|
||||
parts_names.append(part_name)
|
||||
part_size = int(children[child_id + 1].find(QName(
|
||||
NAMESPACES['vt'], 'i4').text).text)
|
||||
parts_size[part_name] = part_size
|
||||
return parts_size, parts_names
|
||||
|
||||
|
||||
def read_sheets_titles(xml_source):
|
||||
"""Read titles for all sheets."""
|
||||
root = fromstring(xml_source)
|
||||
titles_root = root.find(QName('http://schemas.openxmlformats.org/officeDocument/2006/extended-properties',
|
||||
'TitlesOfParts').text)
|
||||
vector = titles_root.find(QName(NAMESPACES['vt'], 'vector').text)
|
||||
parts, names = get_number_of_parts(xml_source)
|
||||
|
||||
# we can't assume 'Worksheets' to be written in english,
|
||||
# but it's always the first item of the parts list (see bug #22)
|
||||
size = parts[names[0]]
|
||||
children = [c.text for c in vector.getchildren()]
|
||||
return children[:size]
|
||||
|
||||
|
||||
def read_named_ranges(xml_source, workbook):
|
||||
"""Read named ranges, excluding poorly defined ranges."""
|
||||
named_ranges = []
|
||||
root = fromstring(xml_source)
|
||||
names_root = root.find(QName('http://schemas.openxmlformats.org/spreadsheetml/2006/main',
|
||||
'definedNames').text)
|
||||
if names_root is not None:
|
||||
|
||||
for name_node in names_root.getchildren():
|
||||
range_name = name_node.get('name')
|
||||
|
||||
if name_node.get("hidden", '0') == '1':
|
||||
continue
|
||||
|
||||
valid = True
|
||||
|
||||
for discarded_range in DISCARDED_RANGES:
|
||||
if discarded_range in range_name:
|
||||
valid = False
|
||||
|
||||
for bad_range in BUGGY_NAMED_RANGES:
|
||||
if bad_range in name_node.text:
|
||||
valid = False
|
||||
|
||||
if valid:
|
||||
destinations = split_named_range(name_node.text)
|
||||
|
||||
new_destinations = []
|
||||
for worksheet, cells_range in destinations:
|
||||
|
||||
# it can happen that a valid named range references
|
||||
# a missing worksheet, when Excel didn't properly maintain
|
||||
# the named range list
|
||||
#
|
||||
# we just ignore them here
|
||||
worksheet = workbook.get_sheet_by_name(worksheet)
|
||||
if worksheet:
|
||||
new_destinations.append((worksheet, cells_range))
|
||||
|
||||
named_range = NamedRange(range_name, new_destinations)
|
||||
named_ranges.append(named_range)
|
||||
|
||||
return named_ranges
|
||||
@@ -0,0 +1,117 @@
|
||||
# file openpyxl/reader/worksheet.py
|
||||
|
||||
# Copyright (c) 2010 openpyxl
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
# @license: http://www.opensource.org/licenses/mit-license.php
|
||||
# @author: Eric Gazoni
|
||||
|
||||
"""Reader for a single worksheet."""
|
||||
|
||||
# Python stdlib imports
|
||||
try:
|
||||
from xml.etree.cElementTree import iterparse
|
||||
except ImportError:
|
||||
from xml.etree.ElementTree import iterparse
|
||||
|
||||
from io import StringIO
|
||||
|
||||
# package imports
|
||||
from ..cell import Cell, coordinate_from_string
|
||||
from ..worksheet import Worksheet
|
||||
|
||||
def _get_xml_iter(xml_source):
|
||||
|
||||
if not hasattr(xml_source, 'name'):
|
||||
return StringIO(xml_source)
|
||||
else:
|
||||
xml_source.seek(0)
|
||||
return xml_source
|
||||
|
||||
def read_dimension(xml_source):
|
||||
|
||||
source = _get_xml_iter(xml_source)
|
||||
|
||||
it = iterparse(source)
|
||||
|
||||
for event, element in it:
|
||||
|
||||
if element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}dimension':
|
||||
ref = element.get('ref')
|
||||
|
||||
if ':' in ref:
|
||||
min_range, max_range = ref.split(':')
|
||||
else:
|
||||
min_range = max_range = ref
|
||||
|
||||
min_col, min_row = coordinate_from_string(min_range)
|
||||
max_col, max_row = coordinate_from_string(max_range)
|
||||
|
||||
return min_col, min_row, max_col, max_row
|
||||
|
||||
else:
|
||||
element.clear()
|
||||
|
||||
return None
|
||||
|
||||
def filter_cells(xxx_todo_changeme):
|
||||
|
||||
(event, element) = xxx_todo_changeme
|
||||
return element.tag == '{http://schemas.openxmlformats.org/spreadsheetml/2006/main}c'
|
||||
|
||||
def fast_parse(ws, xml_source, string_table, style_table):
|
||||
|
||||
source = _get_xml_iter(xml_source)
|
||||
|
||||
it = iterparse(source)
|
||||
|
||||
for event, element in filter(filter_cells, it):
|
||||
|
||||
value = element.findtext('{http://schemas.openxmlformats.org/spreadsheetml/2006/main}v')
|
||||
|
||||
if value is not None:
|
||||
|
||||
coordinate = element.get('r')
|
||||
data_type = element.get('t', 'n')
|
||||
style_id = element.get('s')
|
||||
|
||||
if data_type == Cell.TYPE_STRING:
|
||||
value = string_table.get(int(value))
|
||||
|
||||
ws.cell(coordinate).value = value
|
||||
|
||||
if style_id is not None:
|
||||
ws._styles[coordinate] = style_table.get(int(style_id))
|
||||
|
||||
# to avoid memory exhaustion, clear the item after use
|
||||
element.clear()
|
||||
|
||||
from ..reader.iter_worksheet import IterableWorksheet
|
||||
|
||||
def read_worksheet(xml_source, parent, preset_title, string_table,
|
||||
style_table, workbook_name = None, sheet_codename = None):
|
||||
"""Read an xml worksheet"""
|
||||
if workbook_name and sheet_codename:
|
||||
ws = IterableWorksheet(parent, preset_title, workbook_name,
|
||||
sheet_codename, xml_source)
|
||||
else:
|
||||
ws = Worksheet(parent, preset_title)
|
||||
fast_parse(ws, xml_source, string_table, style_table)
|
||||
return ws
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user