Compare commits

...

164 Commits

Author SHA1 Message Date
Davide Andreoli c8d7bddb47 Do not try to build with Cython3
Thanks goes @rafspiny for pointing this out
2023-11-26 08:36:10 +01:00
Davide Andreoli 4bb6d9fa9f Update package metadata 2023-11-26 08:35:02 +01:00
Davide Andreoli 0b089a5623 Silence pycharm warnings in setup.py 2023-11-26 08:34:14 +01:00
Davide Andreoli a7464e66e6 Maintenance release 1.26.1 2023-10-08 05:45:50 +02:00
Davide Andreoli d1b4512e52 open new development phase 2022-02-27 20:26:17 +01:00
Davide Andreoli 9896656574 Prepare release 1.26.0 2022-02-27 20:21:54 +01:00
Davide Andreoli fb649f30e7 packaging is required to build the wheel 2022-02-27 19:49:30 +01:00
Davide Andreoli f0ab762e16 Copyright 2022 2022-02-27 19:07:34 +01:00
Davide Andreoli 4548c5a01b Fixes a memory error
as reported at:
https://phab.enlightenment.org/D12326
and
https://build.opensuse.org/request/show/945361

thanks goes to Andreas Schwab and Simotek
2022-02-27 11:19:23 +01:00
Davide Andreoli cadc757e7e setup: use packaging instead of distutils for version check
Distutils is deprecated in py3.10, and packaging is already a
dependency of setuptools
2022-02-27 10:52:50 +01:00
Davide Andreoli ed959b59af Update README 2021-12-06 14:27:47 +01:00
Davide Andreoli ec2b95ceab README: remove not maintained/broken apps
Also add some TODO items and fix an htts link
2021-12-06 11:00:13 +01:00
Davide Andreoli dcf362b03f Update README 2021-12-06 09:26:49 +01:00
Davide Andreoli d420f60e0d updated release instructions 2021-12-05 19:18:25 +01:00
Davide Andreoli 0848286409 fix pip uploading
...a really stupid fix
2021-12-05 18:56:44 +01:00
Davide Andreoli 3ca71a067e Dropped python 2.6 support
and deprecate all versions of python 2, with a big-fat warning.
Python2 support will be fully removed in a later release.
2021-12-05 16:13:22 +01:00
Davide Andreoli 9dce9ccad4 setup: stop importing the version from sources
This was creating all sort of issues, because the efl modules in sources
are not meant to work. And installation from sdist using pip was
complainig about efl not found (because it build in a restricted env)

So just read the __init__.py file and extract the version from there
(to be DRY)
2021-12-05 12:24:38 +01:00
Davide Andreoli 7141f21f0b setup: disjoint pythonefl version from efl version
minor version of bindings and efl are not always the same
2021-12-05 12:04:09 +01:00
Davide Andreoli fabcef1278 setup: Factorize reading files and cmd exec 2021-12-05 12:00:47 +01:00
Davide Andreoli a0a6d756b5 Fix install using pip
pip run setup.py bdist_wheel so we need to take that into account

this also fix generation of wheels in general
2021-12-05 10:43:36 +01:00
Davide Andreoli e467b3e871 Change build tool from distutils to setuptools
This is needed for publishing on pip
2021-12-03 08:37:56 +01:00
Davide Andreoli 69cfc2c7fc Docs: always show the breadcumb 2021-11-30 09:21:20 +01:00
Davide Andreoli f70d7c949f Docs: a better flax layout, also with sticky sidebar 2021-11-30 09:19:48 +01:00
Davide Andreoli 838d4b38c5 Docs: comment out unused js 2021-11-29 22:25:05 +01:00
Davide Andreoli b821107688 Docs: updated links 2021-11-29 08:21:38 +01:00
Davide Andreoli e7545e3185 Docs: a bit of style 2021-11-29 08:12:32 +01:00
Davide Andreoli 5ac4f71131 Docs: set pygment style in theme, not in config 2021-11-29 04:56:53 +01:00
Davide Andreoli 7e4116335a Docs: updated sphinx base html theme 2021-11-29 04:55:20 +01:00
Davide Andreoli 26e2b89a9d Docs: use png for inheritance graphs
svg looks a bit better, but the links are then broken :(
2021-11-18 08:21:47 +01:00
Davide Andreoli 2d0668c548 A bit of linting 2021-11-18 07:22:27 +01:00
Davide Andreoli a83da00bc7 Docs: cleanup the conf file
Regenerate from a fresh sphinx-quickstart
2021-11-18 07:02:41 +01:00
Davide Andreoli 31a147fc7c Docs: remove an old workaround
The ClassName(...) on each class was an old hack that is
not needed anymore
2021-11-18 06:25:19 +01:00
Davide Andreoli 1f441a18c8 typo in README 2021-11-17 08:58:51 +01:00
Davide Andreoli d7275844f1 Docs: fix generation of class methods
autodoc_default_flags is deprecated and do not work anymore with sphinx 4.1
Use autodoc_default_options instead

Also separate __init__ and class docs, seems more explicit to me
2021-11-17 08:50:12 +01:00
Davide Andreoli f3c99eeafa gitignore++ 2021-11-14 23:25:02 +01:00
Davide Andreoli 3dfacc01ab Docs: added infra for tutorials
Also remove some really old presentation text,
we should write some new intro
2021-11-14 23:24:18 +01:00
Davide Andreoli 22274ae81d Docs: remove not needed files 2021-11-14 23:21:00 +01:00
Davide Andreoli 25ed1cc567 Fix build after README rename
whopsss
2021-11-14 20:24:02 +01:00
Davide Andreoli 22203c0838 Remove the old TODO file 2021-11-12 07:58:46 +01:00
Davide Andreoli 0253f9e178 New markdown README 2021-11-12 07:51:27 +01:00
Davide Andreoli 55e9e51f69 Open 1.26 development phase 2020-09-24 19:31:13 +02:00
Davide Andreoli 5a81c2c944 Prepare 1.25 release 2020-09-24 19:04:53 +02:00
Davide Andreoli 5a02f13210 Do not fail when build with CC="clang"
clang seems much better in building elementary, while gcc need a lot
of ram and tend to fail badly

So for now on clang is the suggested compiler to use
2020-06-25 18:54:03 +02:00
Davide Andreoli 22cc200a61 Back to devel mode 2020-04-30 08:13:09 +02:00
Davide Andreoli 09e016bdbd Update release instructions 2020-04-30 07:57:59 +02:00
Davide Andreoli bd81c36cd0 Prepare the 1.24 release 2020-04-30 07:46:20 +02:00
Davide Andreoli 81c48dd2d9 Explicitly declare efl submodules
seems to make editors happier
2020-04-29 08:37:53 +02:00
Davide Andreoli b9117cb590 Update INSTALL 2020-04-27 20:04:16 +02:00
Davide Andreoli 32aec52918 Fix tests 2020-04-27 20:02:57 +02:00
Davide Andreoli a7e86793c3 Follow efl rename Efl.Canvas.Text -> Efl.Canvas.Textblock 2020-04-27 20:02:08 +02:00
Davide Andreoli a1eeae15f8 gitignore++ 2020-04-27 19:16:23 +02:00
Davide Andreoli 9ba5210a6a Open up development phase 2019-10-06 11:29:09 +02:00
Davide Andreoli d61c596278 Prepeare the 1.23 release 2019-10-06 08:45:57 +02:00
Davide Andreoli e2ce1b49a3 Open up 1.23 development 2019-04-26 11:30:26 +02:00
Davide Andreoli 8ff30f9edd Prepare 1.22 release 2019-04-23 09:18:32 +02:00
Davide Andreoli d544412cd1 Follow Eo class name changes 2019-04-23 09:13:45 +02:00
Davide Andreoli 3b0552259d Silence Cython warnings
I'm keeping python 2 style for compatibility reasons
2019-04-23 08:55:29 +02:00
Davide Andreoli 4fa39916ee Fix for 1.22 Eo api changes 2019-04-23 08:54:13 +02:00
Davide Andreoli 42ee207c16 In development mode again 2018-08-26 11:42:24 +02:00
Davide Andreoli c9f5b53e28 Try to fix tests on jenkins
Seems this test do not have enough time,
lets try with an higher timeout
2018-08-23 19:56:04 +02:00
Davide Andreoli 8cc259ca26 Remove Systray leftovers 2018-08-23 19:55:46 +02:00
Davide Andreoli d25784cca8 Prepare the 1.21 release 2018-08-23 19:07:46 +02:00
Davide Andreoli 7c555cc9da Say goodbye to the Systray widget
This is a really bad break !!!

... shame on us to have used an efl beta api :(
2018-08-22 21:01:20 +02:00
Davide Andreoli 3e198f7294 Disable a failing test
This is failing only when used in the full suite (00_run_all_tests)

it works normally if launched directly, so I think it's just a
test suite issue
2018-08-21 20:08:23 +02:00
Davide Andreoli b855a82160 This test now work as expected 2018-08-17 11:02:15 +02:00
Davide Andreoli 583f42b131 Setup warnings-- 2018-08-17 10:52:42 +02:00
Davide Andreoli 2991a6683e Fix elm.Image.file.__get__
This is to hide a behaviour changes in elm, quite a corner case, but
spotted by our tests.

If you do a file_get before a file_set, elm is nomore nullifying the
pointers, thus we try to ctouni our garbage. Just initialize well
our vars
2018-08-17 10:46:00 +02:00
Davide Andreoli fb9b06931e Ctxpopup: add slow test with many items
just to replicate the C example
2018-07-22 08:14:12 +02:00
Davide Andreoli 48d9c26945 New 1.21 API: edje.Object.part_text_prediction_hint_hash_set/del 2018-07-22 08:04:09 +02:00
Davide Andreoli 4721842b1e New 1.21 API: elm.Entry.prediction_hint_hash_set/del 2018-07-22 07:51:16 +02:00
Davide Andreoli 6aa3501136 New 1.21 API: Ecore_Exe_Flags.ECORE_EXE_ISOLATE_IO
just a new enum value
2018-07-16 20:16:16 +02:00
Davide Andreoli 18ca98e66f New 1.21 API: Ctxpopup item_insert_before/after
with test
2018-07-16 20:00:50 +02:00
Davide Andreoli 006052543f Fix 2 changed class names
#FollowTheWhiteRabbit
2018-07-15 08:15:44 +02:00
Davide Andreoli 30c9c60b5d Fix warnings spotted by cython 0.28
Those are all simbols redeclared in different places
2018-03-24 08:42:31 +01:00
Davide Andreoli 26607a0986 Changes to make cython 0.28 happy
This just refactor how the extensions are named, nothing
is changed in the final layout of the package.

Renamed the dbus extension, that was indeed the only
one with a different naming scheme.

Also raised the minimum cython version a bit, min is
now at 0.23.5, that is still quite old. The oldest
ones seems to not like the new naming scheme.
2018-03-19 21:16:53 +01:00
Davide Andreoli ffc3c337dc Elm: fix Layout.content_swallow_list_get() to not leak
The eina_list_free was wrongly used and was leaking
the whole list. Fixed.
2018-03-04 09:46:21 +01:00
Davide Andreoli 4b8ddcff7d Elm: add test for elm_image_get() before a set() call 2018-03-01 18:32:46 +01:00
Davide Andreoli 00d92cbebe Changed (again) all the elm class names
#FollowTheWhiteRabbit
2018-02-17 01:18:14 +01:00
Davide Andreoli f81fc890bb systray do not work anymore as the widget has been removed from efl :(
... we still need to decide what to do with this breakage
2017-12-12 19:25:39 +01:00
Davide Andreoli 28c9775898 rename Edje.Object to Efl.Canvas.Layout
#FollowTheWhiteRabbit

also fix a small typo in the Makefile
2017-12-09 20:42:20 +01:00
Davide Andreoli 344da31ceb Efl.Ui.Spinner downgraded to Elm.Spinner
#FollowTheWhiteRabbit
2017-09-07 19:30:34 +02:00
Davide Andreoli bc9d5648e7 Fix an evas test
...not that I really understand the utility nor the root cause of tha fail
but this test was segfaulting
2017-09-03 20:33:26 +02:00
Davide Andreoli 58ab1d26f7 Some new OE widget names
#FollowTheWhiteRabbit
2017-09-03 20:28:07 +02:00
Davide Andreoli fe144b8f96 Pypi is migrating, adjust the release instructions 2017-08-16 21:51:59 +02:00
Davide Andreoli efcebb52bf open up the 1.21 development cycle 2017-08-09 08:54:06 +02:00
Davide Andreoli 7d3799d7fa Prepare the 1.20.0 release 2017-08-05 19:05:00 +02:00
Davide Andreoli 85e23f2851 Prepare the 1.20.0-beta1 pre-release 2017-07-22 18:10:16 +02:00
Davide Andreoli c5759b6d67 New 1.20 API: elm.Menu.open() 2017-07-22 17:39:23 +02:00
Davide Andreoli 5bbaba2a6e New 1.20 API: elm.Genlist.multi_select_mode
with test
2017-07-22 17:24:06 +02:00
Davide Andreoli 74ed9e86a4 Use the buffer engine for elm tests
This should make tests work also on jenkins
2017-07-22 11:35:28 +02:00
Davide Andreoli 3ef64e685c Some more tests cleanups
Now I get 100% success on my machine :)
2017-07-22 11:22:15 +02:00
Davide Andreoli 6e2b444712 Use new style import in elm tests
For some obscure reasons the elm tests was failing here (only when run from the setup.py command) with the old style imports
2017-07-22 11:09:15 +02:00
Davide Andreoli 7d8049b0c5 Adjust some more tests 2017-07-22 10:57:24 +02:00
Davide Andreoli 741000d423 Move elm external test from edje to elm
elm widgets need an elm parent to work correctly, so it's better to use an elm win instead of a ecore evas one.
2017-07-22 10:55:04 +02:00
Davide Andreoli fecc0c2604 Edje: remove custom __repr__ implementation
to be consistent with the others
2017-07-22 09:08:03 +02:00
Davide Andreoli 9d5efd8aef Do not test Combobox widget
it is deprecated
2017-07-22 08:46:19 +02:00
Davide Andreoli 25f620ef19 python-edje do not exists anymore 2017-07-22 08:42:14 +02:00
Davide Andreoli 6e80968778 test list: use a correct FDO icon name 2017-07-20 21:29:46 +02:00
Davide Andreoli 64584362b7 setup.py: clean ecore_input files in CleanGenerated 2017-07-16 20:28:44 +02:00
Davide Andreoli 8ad73b3e69 Ecore.Poller is no more an Eo object in C :( 2017-07-16 14:12:32 +02:00
Davide Andreoli 5b9ba62e8f Fix a nasty ecore.x and ecore.input conflict
Both modules register the ECORE_EVENT_* events, so if you use them toghether one of the 2 was failing to run because the events was already registered by the other.

I'm fixing this by keeping a local event map in ecore.input, not the cleaner solution but it's the safer one I can found (in term of backward compatibility)

This fix (at least) epymc in standalone mode (without a wm)
2017-07-15 22:52:39 +02:00
Davide Andreoli 26a4c38d67 New 1.20 API: evas.Map.coords_get 2017-07-15 17:30:19 +02:00
Davide Andreoli 15b29e3ce8 New 1.20 API: elm/edje text_prediction_hint
no tests, as I have no idea on how to use this feature
2017-07-15 17:07:08 +02:00
Davide Andreoli 6bd7daa883 New 1.20 API: elm.Spinner min/max,reached events
with test
2017-07-15 10:44:58 +02:00
Kai Huuhko 5864a9dd2d Documentation: Add better documentation about object lifetime 2017-07-09 16:50:24 +03:00
Kai Huuhko a475ecba44 Elementary: Add import to efl.edje
Since we can't always anticipate when Elm will return a pointer to
an Edje object, let's just have the type always available.
2017-06-18 20:30:52 +03:00
Davide Andreoli eace418f9b Some new widget names
#FollowTheWhiteRabbit
2017-06-18 18:38:25 +02:00
Davide Andreoli bb2a45f013 Open up 1.20 dev cycle 2017-04-21 09:25:30 +02:00
Davide Andreoli 8c7ad9f31f Prepare the 1.19 release 2017-04-18 19:40:42 +02:00
Davide Andreoli d9f06e72a2 Fix evas.Box test
testing the color for a box do not make much sense, and its failing...
2017-04-18 19:22:17 +02:00
Davide Andreoli df221788f0 Fix file_download test
the old url was not reporting the total size anymore, thus making the test fail
2017-04-18 19:21:04 +02:00
Davide Andreoli 6a7e698368 New 1.19 API: evas.Image.load_head_skip 2017-04-15 20:41:14 +02:00
Davide Andreoli 4557daa602 EcoreConUrl is no more an Eo object :(
#FollowTheWhiteRabbit
2017-04-15 20:20:08 +02:00
Kai Huuhko a70c42e681 elm: Don't allow FontProperties to be freed manually
This could easily lead to segfaults and double frees if the lifetime of the Python object is not managed carefully.

We now do the free automatically when the object no longer has references to it.
2017-04-15 16:50:27 +03:00
Davide Andreoli d87e0a5484 another win stack piece 2017-04-04 20:35:29 +02:00
Davide Andreoli 89bb6a1998 Revert "New 1.19 API: elm.Win.stack_*"
This reverts commit f76e272990.

The win stack api has gone in beta,
we can re-revert after the release
2017-04-04 20:22:35 +02:00
Kai Huuhko b06c3151f7 elm: Fix font_properties_get 2017-03-31 17:51:00 +03:00
Davide Andreoli add166fb62 New 1.19 API: elm.Calendar.date_{min,max}
with test
2017-03-15 21:07:10 +01:00
Davide Andreoli 7aec398ede New 1.19 API: elm.ELM_INPUT_PANEL_LAYOUT_VOICE 2017-03-15 19:54:43 +01:00
Davide Andreoli da9258f474 New 1.19 API: elm.GengridItem.custom_size 2017-03-15 19:41:17 +01:00
Davide Andreoli 9c00cbb0fe New 1.19 API: elm.Naviframe "item,activated" cb
with test refactor/reformat
2017-02-27 20:23:02 +01:00
Davide Andreoli 18e2d9c102 Make the new image test py2 compat 2017-02-26 22:54:18 +01:00
Davide Andreoli 71354b3bb8 New 1.19 API: elm.Image.async_open + 4 new callbacks
with test
2017-02-26 22:50:25 +01:00
Davide Andreoli a293b4e124 Split 2 elm.Image tests in 2 files 2017-02-26 21:29:11 +01:00
Davide Andreoli e3224c882a whops, forgot compat wrappers for added enums 2017-02-26 21:08:03 +01:00
Davide Andreoli dccd0ed62f New 1.19 API: ELM_CALENDAR_REVERSE_DAILY 2017-02-26 20:59:38 +01:00
Davide Andreoli 9231e530bf New 1.19 API: elm.Progressbar.is_pulsing
with a stipid test
2017-02-26 10:30:29 +01:00
Davide Andreoli 6f92607ba4 New 1.19 API: elm.Panel "toggled" signal
with test
2017-02-26 09:43:15 +01:00
Davide Andreoli f76e272990 New 1.19 API: elm.Win.stack_*
with test
2017-02-25 12:58:42 +01:00
Davide Andreoli 3e0dbeb7f7 New 1.19 API: elm.Panel.scrollable_content_size_get 2017-02-25 10:57:19 +01:00
Davide Andreoli 98b7b2408f Rename class names accordly to Eo recent changes
This will lead do break sooner or later, for example:
Datetime is internally an Efl.Ui.Clock, so once Clock will be renamed we will be at a closed corner :(

#FollowTheWhiteRabbit
2016-12-28 14:11:48 +01:00
Davide Andreoli ac7013064f Silence lots of Eo errors
more info in the code comment
2016-11-05 17:51:00 +01:00
Davide Andreoli f2f8906968 Respect pep8 2016-11-05 15:14:41 +01:00
Davide Andreoli 032750af77 Fix Gengrid.item_insert_after to do the right thing 2016-11-05 15:01:48 +01:00
Davide Andreoli 16fa850f24 Fix for cython 0.25
New cython do not like our cdef @DEPRECATED decorator implementation,
I'm not able to fix it, so I just rewrite it in pure python.

The new one is a bit simpler, it do not print the source file anymore,
but still augment the documentation.

Tested with Cython 0.24.1 and 0.25.1 on both python 2.7 and 3.5, hope is enough.

#IHateCython
2016-11-05 11:42:26 +01:00
Davide Andreoli 0b03f8b2f3 some cc don't like the way cython use EINA_LOG macros
In some system we saw the compilation fail with this error:
efl/eo/efl.eo.c:1137:60: error: format not a string literal and no format arguments [-Werror=format-security]
   EINA_LOG_DOM_INFO(__pyx_v_3efl_2eo_PY_EFL_EO_LOG_DOMAIN, __pyx_k_Initializing_efl_eo);

so just ignore those warnings
2016-10-24 21:15:03 +02:00
Davide Andreoli 810623dbe4 Tests: use correct FDO icon names
Hope I catched them all
2016-10-22 12:33:32 +02:00
Davide Andreoli 01220931fc Evas: Do not call xxx_callback_del if obj is NULL
@fix
2016-10-22 11:43:25 +02:00
Davide Andreoli 924f291660 Test External: more readable indentation 2016-10-22 11:30:51 +02:00
Davide Andreoli 2e5e96a8dd Test Externals: keep in sync with the C test 2016-10-22 11:25:30 +02:00
Davide Andreoli ea4bc8790d warnings -- 2016-10-14 23:16:25 +02:00
Davide Andreoli 9e25d34920 warnings-- 2016-10-14 23:04:27 +02:00
Davide Andreoli 953f468229 Edje_External: fix a wrong var name
spotted by (now readable) warnings
2016-10-14 22:54:50 +02:00
Davide Andreoli f872e7b8c6 Fix usage of EINA_LOG_* functions
spotted by warnings :)
2016-10-14 22:45:32 +02:00
Davide Andreoli e0d892ecaa Silence some false compiler warnings
This make the output a lot more readable, we can now spot real warnings
2016-10-14 22:43:19 +02:00
Davide Andreoli cb062511b2 Makefile: go with py3 by default
this do not affect normal build (python setup.py xxx)
the Makefile is just a shortcut for devs
2016-10-14 22:41:03 +02:00
Davide Andreoli fa5b944f31 Eo: Eo_Event -> Efl_Event
#FollowTheWhiteRabbit (tm)
2016-10-14 21:29:15 +02:00
Davide Andreoli 99c618fc2b Remove ecore warning about subprocess incompatibility
This conflict seems to not exists anymore, the added test should prove it

Also removed unused return values from the existing exe test

(cherry picked from commit 191af7ac380ab87d29e4886fe07cd02b8dd5afa9)
2016-10-02 09:56:27 +02:00
Davide Andreoli 1a2b8e64f8 small doc fix 2016-09-24 13:58:12 +02:00
Kai Huuhko 6ad9bb3521 Emotion: Document module names and mark module options as deprecated 2016-09-03 22:37:49 +03:00
Kai Huuhko 0217da6c1f Emotion: Change default module_name to gstreamer1 2016-09-03 22:37:19 +03:00
Kai Huuhko f7e96cf0af Elm.Spinner: Add two missing signals and fix documentation issues 2016-08-29 18:44:35 +03:00
Kai Huuhko 58cfedf5af Elm.Genlist: Document new "indent" item style 2016-08-26 21:47:46 +03:00
Kai Huuhko 818e7db2e6 Tests: Disable edje edit test that segfaults 2016-08-21 20:02:01 +03:00
Kai Huuhko 6fa2d3ff95 Follow Eo -> Efl renames 2016-08-21 19:53:41 +03:00
Davide Andreoli 212eca4321 1.19 development starts now 2016-08-21 15:57:21 +02:00
Davide Andreoli cca359974a Prepare the 1.18.0 release 2016-08-20 09:32:49 +02:00
Kai Huuhko f652b6e18f Evas.Smart: Store event string in the spec to ensure it doesn't get decreffed
This fixes event string corruption and segfault in epymc
2016-08-16 22:57:09 +03:00
Kai Huuhko fdab8ed5b6 tests: Fix edje decorators test
Commit dd584b9f79ec41b53ca620ae534fcf84f12e30a9 fixed bad behaviour in edje entry.

Our test was picking up the "changed" and "cursor,changed" signals emitted by edje entry
when its text was set to "" on creation. Raster changed this behaviour, removing the
emissions, so let's do the same in our test and add some future proofing as well.

Fixes T4374
2016-08-16 21:57:21 +03:00
Kai Huuhko b2af779d7d Switch enums to use the old system we had previously
This allows us to support Cython 0.23+
2016-08-16 10:11:34 +03:00
Davide Andreoli 4bd421562d Improve the ecore test suite
no more print and lots more asserts
2016-08-14 13:02:19 +02:00
Davide Andreoli d6fc38ea59 ecore.Exe: implement is_deleted for consistency with other classes 2016-08-14 11:58:49 +02:00
Davide Andreoli 380e7a58ff ecore.FdHandler: implement is_deleted for consistency with other classes 2016-08-14 10:35:58 +02:00
Davide Andreoli 939cd71702 Small Timer docs improvement 2016-08-14 08:55:01 +02:00
299 changed files with 7317 additions and 5828 deletions

5
.gitignore vendored
View File

@ -28,4 +28,9 @@ pip-log.txt
# Cython generated files
efl/*/*.c
efl/*/*.h
!efl/dbus_mainloop/e_dbus.*
efl/*/*.html
# Various editors trash
.idea/
.vscode/

10
.pylintrc Normal file
View File

@ -0,0 +1,10 @@
[MESSAGES CONTROL]
#enable=
disable=consider-using-f-string, # for older python we still support
redundant-u-string-prefix, # for older python we still support
invalid-name, # seems too pedantic to me
missing-function-docstring,
missing-class-docstring,
missing-module-docstring,

118
CODING
View File

@ -1,3 +1,28 @@
TODO
====
* Automatically build and publish binary wheels on pypi
- for py: 36,37,38,39,310
- for linux x86 and rpi
- see https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
- see https://github.com/pypa/manylinux
- also include efl itsef in the wheels? PySide is doing this
* Drop python 2 compatibility
- Switch to cython3
- remove all the workarounds for py2 (see strings and enums)
* Improved editors support, at least on VSCode and PyCharm
* Try to implement better the elementary module, removing
the __init__ module hack (that create problems in the docs)
* Make the examples a first citizen!
- install them with python efl
- make them easily runnable
- show them in the docs
- show the code inside the examples themself?
- make the code editable on the fly?
Style
=====
@ -98,65 +123,54 @@ Tips
Release process instructions
============================
* Announce at enlightenment-release@lists.sourceforge.net and
enlightenment-devel@lists.sourceforge.net that you are planning for the release
* Change versions in efl/__init__.py (ex: 1.9.0)
* use "api_coverage.py --python elementary" to see the missing bindings
* Version:
- change versions in efl/__init__.py (ex: 1.9.0)
- update EFL_MIN_VER in setup.py (if needed)
* Update the ChangeLog file:
setup.py build_doc -b changes ...and manually merge from the html file
* Git push and wait jenkins to generate the 2 tarballs
* Test the generated tarballs
* scp tarballs & md5sums to:
download.enlightenment.org:/srv/web/download.enlightenment.org/public_html/pre-releases/
* Announce at enlightenment-release@lists.sourceforge.net and
enlightenment-devel@lists.sourceforge.net that tarballs are ready for testing
- setup.py build_doc -b changes ...and manually merge from the html file
... wait 24 hours, fix any issues found. In the mean time you can prepare the
release announcement for phame/ml.
* Generate the source (tar) and binary (wheel) distributions:
- make maintainer-clean (just to be sure nothing is cached)
- make dist
* Test the generated tarball and wheel:
- the targz must work by extracting and running: python setup.py install [--user]
- the targz must be installable using: pip install python-efl-1.9.0.tar.gz
- the wheel must be installable using: pip install python_efl-1.9.0-xxxx.whl
* Publish the 2 tar archive on e.org:
- scp tarballs & md5sums to:
download.enlightenment.org:/srv/web/download.enlightenment.org/rel/bindings/python/
- update download link on the wiki (www.enlightenment.org/download)
* Publish the .tar.gz archive on pypi:
- twine upload python-efl-1.9.0.tar.gz [--repository testpypy]
- TODO: also upload binary wheels for linux py36,37,38,39,310 (see manylinux on pypa)
* Documentation:
- make doc (check that inheritance graphs are there)
- scp the generated html documentation to:
download.enlightenment.org:/srv/web/docs.enlightenment.org/python-efl/1.9.0/
- update the 'current' link on the server (ssh)
* ssh to download.enlightenment.org and mv tarballs & md5sums to:
/srv/web/download.enlightenment.org/public_html/rel/bindings/python/
* Upload the .tar.gz archive to pypi:
- first upload the PKG-INFO file from the "edit" section on pypi
- then upload the tarball from the "files" section
* Create and push the tag for the release
git tag -a v1.9.0 && git push origin v1.9.0
- git tag -a v1.9.0 && git push origin v1.9.0
* Create and push the branch for stable backporting
git branch python-efl-1.9 && git push origin python-efl-1.9
* scp the generated html documentation to:
download.enlightenment.org:/srv/web/docs.enlightenment.org/public_html/python-efl/1.XX.0/
and update the 'current' link on the server (ssh)
* Update download link on the wiki (www.enlightenment.org/download)
* Publish the blog post on phame (Official Announcements)
* Announce the release to release@lists.enlightenment.org
* Announce the release to release@lists.enlightenment.org and
enlightenment-release@lists.sourceforge.net
* Change versions again in efl/__init__.py (ex: 1.9.99)
more info at:
phab.enlightenment.org/w/release_procedure/
for more info:
--------------
* packaging.python.org
* phab.enlightenment.org/w/release_procedure/
* phab.enlightenment.org/w/hosting/ssh/
Discussion
==========
* Internal utility functions used in the bindings must start with an
underscore and must have the shortest name as possible.
^
This needs further discussion/expansion.
When we define a function with cdef it is not exposed to Python API.
This should be explicit enough to not need the underscore prefix, which
at best looks ugly, and at worst just plain confusing.
A function name should summarize its functionality in one clear text,
short sentence. We have both too long and too short names. And I admit to
being guilty of adding many of both.
Let's build up a short review so we can see where we stand with this and
make necessary corrections.
/ kuuko
The underscore usage is a coding standard in all the EFL, we should try
to follow the efl style also here (where is possible and make sense)
/ davemds

182
ChangeLog
View File

@ -1,3 +1,185 @@
===================
2023-10-08 v1.26.1
===================
Maintenance release:
* rebuilt using Cython 0.29.34 to fix install on python 3.11
===================
2022-02-27 v1.26.0
===================
Changes:
* Switched to setuptools for the build system (can now install from pip again)
* Dropped py2.6 support, minimum is now 2.7
* Deprecated python2 support, with a big-fat-slow warning
* Improved documentation
Fixes:
* Fixed a memory allocation error in EvasSmart
===================
2020-09-24 v1.25.0
===================
Changes:
* Switched to Cython 0.29.21 for the tarball generation
===================
2020-04-30 v1.24.0
===================
Changes:
* Switched to Cython 0.29.16 for the tarball generation
* No more pypi packages uploaded, you must install from tarball
===================
2019-10-06 v1.23.0
===================
Changes:
* Switched to Cython 0.29.13 for the tarball generation
===================
2019-04-23 v1.22.0
===================
Changes:
* Switched to Cython 0.29.7 for the tarball generation
===================
2018-08-24 v1.21.0
===================
BREAKS:
* systray.pxi do not work anymore as the widget has been removed from efl.
The widget has been completly removed and the function elm_need_systray
now always return False that means systray is not available.
Apologies for the inconvenient.
Changes:
* Switched to Cython 0.28.4 for the tarball generation, should fix build
issues with python3.7
Additions:
* ecore.ECORE_EXE_ISOLATE_IO
* edje.part_text_prediction_hint_hash_del
* edje.part_text_prediction_hint_hash_set
* elm.Entry.prediction_hint_hash_del
* elm.Entry.prediction_hint_hash_set
* elm.Ctxpopup.item_insert_after
* elm.Ctxpopup.item_insert_before
===================
2017-05-06 v1.20.0
===================
Fixes:
* ecore.input and ecore.x can now coexsist
Changes:
* ecore.Poller is no more an Eo object in C (nothing should be changed in py)
* removed edje.Object custom __repr__ implementation
* Use Cython 23.5 to generate the C source in dist tarball (see T5589)
Additions:
* elm.Entry.prediction_hint
* elm.Genlist.multi_select_mode
* elm.Menu.open()
* elm.Spinner.callback_max_reached_add()
* elm.Spinner.callback_max_reached_del()
* edje.part_text_prediction_hint_set()
* evas.Map.coords_get()
===================
2017-04-18 v1.19.0
===================
Fixes:
* Fixes for cython 0.25 compatibility
* elm.font_properties_get
* elm.Gengrid.item_insert_after now work as expected
Changes:
* Removed ecore warning about subprocess incompatibility, with test to prove it
* Emotion: changed default module_name to "gstreamer1"
* elm.font_properties_free: Changed to no-op as we now do the free
automatically when there are no more references to the FontProperties object
* elm.Panel.scrollable_content_size is now also readable
* EcoreConUrl is no more an Eo object in C
Additions:
* evas.Image.load_head_skip
* elm.ELM_INPUT_PANEL_LAYOUT_VOICE
* elm.ELM_CALENDAR_REVERSE_DAILY
* elm.Calendar.date_max
* elm.Calendar.date_min
* elm.GengridItem.custom_size
* elm.Image.async_open
* elm.Image.callback_load_cancel_add
* elm.Image.callback_load_error_add
* elm.Image.callback_load_open_add
* elm.Image.callback_load_ready_add
* elm.Naviframe.callback_item_activated_add
* elm.Panel.callback_toggled_add
* elm.Progressbar.is_pulsing
* elm.Spinner.callback_drag_start_add
* elm.Spinner.callback_drag_stop_add
===================
2016-08-22 v1.18.0
===================
Fixes:
* Fixed (workaround) dbus crash on python >= 3.5
* Fixed Logger module to not fail on unicode error messages
Changes:
* Changed enums implementation to gain compatibility with Cython > 0.22
* Docs: Allow to skip last_updated and sphinx_version
* elm.Combobox: The combobox widget has been deprecated.
* elm.Photo.editable property is now also readable
* elm.Photo.fill_inside property is now also readable
* elm.Photo.size property is now also readable
Additions:
* ecore.Exe.is_deleted
* ecore.FdHandler.is_deleted
* edje.Edje.part_box_insert_after
* elm.Configuration.accel_preference_override
* elm.Configuration.first_item_focus_on_first_focusin
* elm.Configuration.font_hint_type
* elm.Configuration.icon_theme
* elm.Configuration.popup_scrollable
* elm.Configuration.scroll_accel_factor
* elm.Configuration.scroll_animation_disabled
* elm.Configuration.vsync
* elm.Configuration.web_backend
* elm.Entry.file_text_format
* elm.Entry.select_allow
* elm.Entry.select_region
* elm.GengridItem.all_contents_unset
* elm.Genlist.filtered_items_count
* elm.GenlistItem.all_contents_unset
* elm.List.multi_select_mode (and the Elm_Object_Multi_Select_Mode enum)
* elm.Object.focus_move_policy_automatic
* elm.Popup.align
* elm.Popup.scrollable
* elm.Slider.range
* elm.Slider.range_enabled
* elm.Slider.indicator_show_on_focus
* elm.Transit.revert
* elm.Window.noblank
==================
2016-01-7 v1.17.0

18
INSTALL
View File

@ -3,22 +3,19 @@
===============
* Python 2.6 or higher, 3.2 or higher (http://www.python.org/)
- Tested with Python 2.7 / 3.3 / 3.4
- Tested with Python 3.8
* Cython 0.21 or higher (http://cython.org/)
- Tested with Cython 0.21.2
- Tested with Cython 0.29.16
* EFL core library
- eo, evas, ecore, edje, emotion and elementary
* pkg-config (http://www.freedesktop.org/wiki/Software/pkg-config)
- Windows executable (and GLib dependency) can be downloaded from
http://www.gtk.org/download/win32.php
* EFL must be the same minor version of the bindings,
es. python-efl 1.24 need efl 1.24
* To build the DOCS you will also need:
- python-sphinx
- [optional] graphviz
* At least 4GB of free RAM to build
2. BUILDING PYTHON-EFL
@ -29,6 +26,11 @@
python setup.py build
IMPORTANT NOTE:
To build the bindings you will need at least 4GB of free ram!
Otherwise the build process will badly fail.
Distribution tarballs include pre-generated C source files, so
cython usage is disabled by default, while is enabled in development git
versions. You can always force the usage of cython using two environment

View File

@ -16,7 +16,7 @@
#
PY = python
PY = python3
.PHONY: build
@ -29,6 +29,11 @@ install:
$(PY) setup.py install
.PHONY: uninstall
uninstall:
$(PY) setup.py uninstall
.PHONY: doc
doc:
$(PY) setup.py build build_doc
@ -44,12 +49,20 @@ clean:
$(PY) setup.py clean --all
.PHONY: maintaner-clean
maintaner-clean:
.PHONY: maintainer-clean
maintainer-clean:
$(PY) setup.py clean --all clean_generated_files
rm -rf build/
rm -rf dist/
rm -rf python_efl.egg-info/
rm -f installed_files-*.txt
.PHONY: dist
dist:
$(PY) setup.py sdist --formats=gztar,bztar
$(PY) setup.py sdist --formats=gztar,xztar
$(PY) setup.py bdist_wheel
@cd dist/; for f in `ls *.tar.*` ; do \
echo Generating sha256 for: $$f ; \
sha256sum $$f > $$f.sha256; \
done

7
README
View File

@ -1,7 +0,0 @@
EFL is a collection of libraries for handling many common tasks a
developer man have such as data structures, communication, rendering,
widgets and more.
PYTHON-EFL are the python bindings for the whole EFL stack (eo, evas, ecore,
edje, emotion, ethumb and elementary)

92
README.md Normal file
View File

@ -0,0 +1,92 @@
# Python bindings for the EFL
EFL, or the *Enlightenment Foundation Libraries*, is a collection of libraries for handling many common tasks such as data structures, communication, rendering, widgets and more. Read more on the [efl web site](https://www.enlightenment.org/about-efl).
Python-EFL are the python bindings for the whole EFL stack (evas, ecore, edje, emotion, ethumb and elementary). You can use Python-EFL to build a portable GUI application in minutes.
The documentation for Python-EFL is available [here](https://docs.enlightenment.org/python-efl/current/).
## Install from pypi
The last stable release is always available on pypi, and pip is the raccomanded way to install Python-EFL:
```
pip install python-efl
```
The only requirement is to have the EFL already installed on your machine, see [here](https://www.enlightenment.org/docs/distros/start) for install instructions for various linux distro or for building EFL from sources.
NOTE: Currently only sources packages are available on pip, this means that the installation will be quite long as it need to compile all the modules, and that you need a C compiler for installation to work (we highly suggest to use clang as your C compiler). For the next release we have plans to also upload binary packages on pypi, so the installation will be blazing fast and will have zero dependencies!
## Install from released tarballs
All the stable releases of python-efl can always be found at:
https://download.enlightenment.org/rel/bindings/python/
To install download and unpack a tarball and run:
```
python setup.py build
python setup.py install --user
or
sudo python setup.py install (for sistem-wide installation)
```
NOTE: due to strange cython+gcc behaviour we highly suggest to build python-efl using clang. If you experience issues using gcc (like memory exhausted or strange compile errors) just use clang in this way:
```
CC=clang python setup.py build
```
## Source repository
If you would like to contribute to Python-EFL and make changes to the Python-EFL code you need to build from **git**. Development take place in the **master** branch, while we backport bugfixes in the release branches. You will find a branch for each released version, branches are named as **python-efl-X.X**.
To build from git you also need to have [Cython](https://cython.org/) installed.
### Main repository
https://git.enlightenment.org/bindings/python/python-efl.git/
### GitHub repository
https://github.com/DaveMDS/python-efl
The GitHub repo has been created to simplify the workflow for people that do
not have a git account in the E repo, and thus improving collaboration.
Feel free to make pull requests on GitHub.
## Documentation
Documentation for the last stable release can be found [here](https://docs.enlightenment.org/python-efl/current/).
Additionally you can generate the documentation yourself from the source code using the following command:
```
python setup.py build build_doc
```
The HTML generated documentation will be available in the folder: `build/sphinx/html/`
## Some of the projects using Python-EFL (in random order)
| **Project** | **Website** |
|-------------------------------------|------------------------------------------------------|
| **EpyMC** - Media Center | https://github.com/DaveMDS/epymc |
| **Espionage** - D-Bus inspector | https://phab.enlightenment.org/w/projects/espionage/ |
| **Epour** - BitTorrent Client | https://phab.enlightenment.org/w/projects/epour/ |
| **Eluminance** - Fast photo browser | https://github.com/DaveMDS/eluminance |
| **Egitu** - Git User Interface | https://github.com/DaveMDS/egitu |
| **Edone** - GettingThingsDone | https://github.com/DaveMDS/edone |
| **Epack** - Archive extractor | https://github.com/wfx/epack |
... and many more that cannot fit in this short list. If have some code and want it in this list just let us know.
## A short history of Python-EFL
Python-EFL was begun in 2007 by work of Gustavo Sverzut Barbieri and others while working for Nokia on the software project Canola Media Player. The language bindings were initially developed for the individual components of EFL, until merged together in 2013.
He was later joined by Ulisses Furquim Freire da Silva, who together formed the company ProFUSION embedded systems where the developement continued and a new software project called Editje was created, which uses the Python bindings for most of its functionality.
Python-EFL gained many more developers, also at this time an independent application project called EpyMC was created by Davide Andreoli.
In the beginning of the year 2011 the developement was practically halted. In 2012 Davide Andreoli picked up the developement and Kai Huuhko (@kuuko) joined him shortly after. Work at this time was focused on finishing the Python bindings for Elementary, the toolkit library.
In 2013 the individual components were merged together and a new documentation system was implemented, enabling easier access for the end-user developers.
Currently (as in 2022) the bindings are still actively maintained and improved by Davide Andreoli, in his effort to bring to python a powerfull and attractive UI toolkit.

37
TODO
View File

@ -1,37 +0,0 @@
BUGS
====
* EdjeEdit: PartState API does not work
* Elm.Map: overlays_show segfaults, scrollers in examples are jumpy
* Genlist: "filter,done" event is sometimes fired before filter callbacks are done (see the genlist_filter.py test)
Failing unit tests
------------------
* tests.edje.test_04_edit: testPartEffect (marked as known failure)
* tests.edje.test_04_edit: testGroupDel (skipped, segfault)
* tests.edje.test_04_edit: testExternal (skipped, TODO)
TODO
====
* update links and text on:
http://www.freedesktop.org/wiki/Software/DBusBindings
(requires fd.org shell account?)
* Review the internal functions and name them consistently
* edje: complete the unit tests
* Initial Evas GL support (for Elm)
* Add more documentation for callbacks, events, etc.
* Check for missing Eo type mappings
Elm
---
* Automate compilation of the example edje files.
* Add more examples
* Prefs (only supports simple types, not so great for us)
* GLView
* Unit tests
* Images missing in the documentation:
- datetime
- systray
- video
- web
- window ?

View File

@ -25,6 +25,11 @@ c_exclude_list = [
"elm_config_access", # Access disabled until 1.9
"elm_object_item_access", # Access disabled until 1.9
"elm_systray", # We currently have this in using Eo API
"elm_code_", # The code widget is still in beta
"elm_need_e_dbus", # has been deprecated long time ago
"elm_check_selected_get", # We already provide state_get
"elm_check_selected_set", # We already provide state_set
]
c_excludes = "|".join(c_exclude_list)
@ -166,6 +171,8 @@ def get_pyapis(pxd_path, header_name, prefix):
for f in files:
# if not f.endswith(".pxd"):
# continue
if f.endswith(".pyc"):
continue
open_args = (os.path.join(path, f),)
open_kwargs = dict(mode="r")
if sys.version_info[0] > 2:

View File

@ -1,153 +0,0 @@
# 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) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
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 " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " 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/PythonBindingsforEnlightenmentFoundationLibraries.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonBindingsforEnlightenmentFoundationLibraries.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/PythonBindingsforEnlightenmentFoundationLibraries"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonBindingsforEnlightenmentFoundationLibraries"
@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."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@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."

View File

@ -1,40 +1,47 @@
# -*- coding: utf-8 -*-
#
# Python Bindings for EFL Elementary documentation build configuration file, created by
# sphinx-quickstart on Thu Jun 28 09:21:25 2012.
# Configuration file for the Sphinx documentation builder.
#
# 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.
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import sys, os, platform
# pylint: disable=invalid-name
import os
import sys
import platform
# -- Path setup --------------------------------------------------------------
# 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.
d = "lib.%s-%s-%d.%d" % (
platform.system().lower(),
platform.machine(),
sys.version_info[0],
sys.version_info[1]
)
sys.path.insert(0, os.path.abspath("../build/"+d))
#sys.path.insert(0, os.path.abspath('../build/lib.linux-i686-3.2'))
# add these directories to sys.path here.
d = 'lib.%s-%s-%d.%d' % (
platform.system().lower(),
platform.machine(),
sys.version_info[0],
sys.version_info[1]
)
sys.path.insert(0, os.path.abspath('../build/' + d))
# sys.path.insert(0, os.path.abspath('../build/lib.linux-i686-3.2'))
# Delete any previously imported efl package
if "efl" in sys.modules:
del sys.modules["efl"]
if 'efl' in sys.modules:
del sys.modules['efl']
# -- General configuration -----------------------------------------------------
# -- Project information -----------------------------------------------------
project = 'Python EFL'
author = 'The Python-EFL community (see AUTHORS)'
copyright = '2008-2022, ' + author # pylint: disable=redefined-builtin
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.1'
needs_sphinx = '3.1'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@ -46,113 +53,36 @@ extensions = [
# 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'Python EFL'
copyright = u'2008-2015, Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko'
# 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 = 'X.Y'
# The full version, including alpha/beta/rc tags.
# release = 'X.Y.Z'
# 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'
# master_doc = 'index'
# 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 = 'monokai'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# Setting this True will show missing references as warnings.
#nitpicky = True
# nitpick_ignore = [
# ('py:obj', 'int'),
# ('py:obj', 'float'),
# ('py:obj', 'double'),
# ('py:obj', 'callable'),
# ('py:obj', 'function'),
# ('py:obj', 'str'),
# ('py:exc', 'RuntimeError'),
# ('py:exc', 'RuntimeWarning'),
# ('py:exc', 'ValueError'),
# ('py:exc', 'TypeError'),
# ('py:obj', 'Evas_Coord (int)'),
# ('py:obj', 'string'),
# ('py:obj', 'list'),
# ('py:class', 'object'),
# ('py:obj', 'unicode'),
# ('py:obj', 'bool'),
# ('py:obj', 'tuple of ints'),
# ('py:class', 'efl.eo.Eo'),
# ('py:attr', 'efl.eo.Eo.data'),
# ('py:obj', 'datetime.date'),
# ]
# -- Autodoc configuration -----------------------------------------------------
autodoc_default_flags = [
'members',
'show-inheritance',
# 'inherited-members',
# 'undoc-members',
]
autoclass_content = "both"
autodoc_docstring_signature = True
# autodoc_member_order = "bysource"
autodoc_default_options = {
'members': True, # show methods for classes
'show-inheritance': True, # show bases class
'member-order': 'alphabetical', # bysource, alphabetical, groupwise
'no-undoc-members': True, # dont show members without docstring
'no-inherited-members': True, # dont show members from parent classes
}
# both the class and the __init__ methods docstring are concatenated
autoclass_content = 'both'
def setup(app):
from sphinx.ext.autodoc import cut_lines
app.connect('autodoc-process-signature', autodoc_process_signature)
app.connect('autodoc-process-docstring', cut_lines(1, what=['class']))
def autodoc_process_signature(app, what, name, obj, options, signature, return_annotation):
def autodoc_process_signature(_app, what, _name, _obj, _options, signature, return_annotation):
"""Cleanup params: remove the 'self' param and all the cython types"""
if what not in ('function', 'method'):
return
return None
params = list()
params = []
for param in (p.strip() for p in signature[1:-1].split(',')):
if param != 'self':
params.append(param.rpartition(' ')[2])
@ -163,28 +93,28 @@ def autodoc_process_signature(app, what, name, obj, options, signature, return_a
# -- Inheritance Diagram ------------------------------------------------------
try:
import gv
import gv # pylint: disable=unused-import
except ImportError:
pass
else:
extensions.append('sphinx.ext.inheritance_diagram')
# svg scale better (look at the full elm dia)
# but svg links are broken :(
graphviz_output_format = "svg" # png (default) or svg
graphviz_output_format = 'png' # png (default) or svg
inheritance_graph_attrs = dict(
bgcolor = 'gray25', #404040
bgcolor = 'gray25', #404040
)
inheritance_node_attrs = dict(
style = 'rounded', # or 'filled',
# fillcolor = "gray20", # bg color (should be #CCCCCC)
color = 'gray10', # border color (should be #202020)
style = 'rounded', # or 'filled',
# fillcolor = 'gray20', # bg color (should be #CCCCCC)
color = 'gray10', # border color (should be #202020)
fontcolor = 'white',
font = 'sans',
)
inheritance_edge_attrs = dict(
color = 'dodgerblue3', # arrow color (should be #4399FF)
dir = 'none', # arrow direction (back, forward, both or none)
color = 'dodgerblue3', # arrow color (should be #4399FF)
dir = 'none', # arrow direction (back, forward, both or none)
)
@ -193,10 +123,11 @@ else:
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# html_theme = 'alabaster' # Default sphinx theme
# html_theme = 'default' # Classic python style
# html_theme = 'sphinxdoc' # Much modern sphinx style
# html_theme = 'sphinx13' # The latest one from the sphinx site
html_theme = 'efldoc' # EFL dark style
html_theme = 'efldoc' # Our custom EFL dark style
# 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
@ -211,16 +142,16 @@ html_theme_path = ['themes']
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = "Python EFL"
html_short_title = 'Python EFL'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "images/logo.png"
html_logo = 'images/logo.png'
# 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 = "images/logo.ico"
html_favicon = 'images/logo.ico'
# 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,
@ -231,10 +162,6 @@ html_static_path = ['images']
# 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 = {}
@ -270,121 +197,3 @@ html_show_sourcelink = False
# Output file base name for HTML help builder.
htmlhelp_basename = 'PythonEFLdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',