From 10b40b6dafcfcad3d9508df3ee6e3e0ce1334f50 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 14:53:38 +0900 Subject: [PATCH 01/12] Add quickstart template files --- docs/Makefile | 20 ++++++++++++++++ docs/make.bat | 35 +++++++++++++++++++++++++++ docs/source/conf.py | 55 +++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 20 ++++++++++++++++ 4 files changed, 130 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..d0c3cbf10 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..6247f7e23 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 000000000..3e4a94393 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,55 @@ +# Configuration file for the Sphinx documentation builder. +# +# 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 + +# -- 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. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'python_client_doc' +copyright = '2020, Appium' +author = 'Appium' + +# The full version, including alpha/beta/rc tags +release = '1.0.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- 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 = 'alabaster' + +# 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'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 000000000..335c78227 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. python_client_doc documentation master file, created by + sphinx-quickstart on Mon Feb 24 14:52:30 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to python_client_doc's documentation! +============================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From dcd986aa17b642e117186711ba3dc72207d9cce3 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 15:00:47 +0900 Subject: [PATCH 02/12] Update conf file --- docs/source/conf.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e4a94393..3c72ef291 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,9 +10,10 @@ # 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. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys + +sys.path.insert(0, os.path.abspath('../appium/webdriver')) # -- Project information ----------------------------------------------------- @@ -31,6 +32,9 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', + 'sphinx.ext.githubpages' ] # Add any paths that contain templates here, relative to this directory. @@ -47,7 +51,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # 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, From 82a42bcc4e6c834c11406eafd8226410d1b5b6f0 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 15:06:21 +0900 Subject: [PATCH 03/12] Update --- docs/{source => }/conf.py | 0 docs/{source => }/index.rst | 11 +- docs/webdriver.common.rst | 38 +++++ docs/webdriver.extensions.android.rst | 94 +++++++++++ docs/webdriver.extensions.rst | 158 +++++++++++++++++++ docs/webdriver.extensions.search_context.rst | 62 ++++++++ docs/webdriver.rst | 102 ++++++++++++ 7 files changed, 460 insertions(+), 5 deletions(-) rename docs/{source => }/conf.py (100%) rename docs/{source => }/index.rst (53%) create mode 100644 docs/webdriver.common.rst create mode 100644 docs/webdriver.extensions.android.rst create mode 100644 docs/webdriver.extensions.rst create mode 100644 docs/webdriver.extensions.search_context.rst create mode 100644 docs/webdriver.rst diff --git a/docs/source/conf.py b/docs/conf.py similarity index 100% rename from docs/source/conf.py rename to docs/conf.py diff --git a/docs/source/index.rst b/docs/index.rst similarity index 53% rename from docs/source/index.rst rename to docs/index.rst index 335c78227..61c44c180 100644 --- a/docs/source/index.rst +++ b/docs/index.rst @@ -1,15 +1,16 @@ -.. python_client_doc documentation master file, created by - sphinx-quickstart on Mon Feb 24 14:52:30 2020. +.. webdriver documentation master file, created by + sphinx-quickstart on Mon Feb 24 15:05:47 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to python_client_doc's documentation! -============================================= +Welcome to webdriver's documentation! +===================================== .. toctree:: - :maxdepth: 2 + :maxdepth: 4 :caption: Contents: + webdriver Indices and tables diff --git a/docs/webdriver.common.rst b/docs/webdriver.common.rst new file mode 100644 index 000000000..1da461fbb --- /dev/null +++ b/docs/webdriver.common.rst @@ -0,0 +1,38 @@ +webdriver.common package +======================== + +Submodules +---------- + +webdriver.common.mobileby module +-------------------------------- + +.. automodule:: webdriver.common.mobileby + :members: + :undoc-members: + :show-inheritance: + +webdriver.common.multi\_action module +------------------------------------- + +.. automodule:: webdriver.common.multi_action + :members: + :undoc-members: + :show-inheritance: + +webdriver.common.touch\_action module +------------------------------------- + +.. automodule:: webdriver.common.touch_action + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: webdriver.common + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/webdriver.extensions.android.rst b/docs/webdriver.extensions.android.rst new file mode 100644 index 000000000..55a32a1f4 --- /dev/null +++ b/docs/webdriver.extensions.android.rst @@ -0,0 +1,94 @@ +webdriver.extensions.android package +==================================== + +Submodules +---------- + +webdriver.extensions.android.activities module +---------------------------------------------- + +.. automodule:: webdriver.extensions.android.activities + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.common module +------------------------------------------ + +.. automodule:: webdriver.extensions.android.common + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.display module +------------------------------------------- + +.. automodule:: webdriver.extensions.android.display + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.gsm module +--------------------------------------- + +.. automodule:: webdriver.extensions.android.gsm + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.nativekey module +--------------------------------------------- + +.. automodule:: webdriver.extensions.android.nativekey + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.network module +------------------------------------------- + +.. automodule:: webdriver.extensions.android.network + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.performance module +----------------------------------------------- + +.. automodule:: webdriver.extensions.android.performance + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.power module +----------------------------------------- + +.. automodule:: webdriver.extensions.android.power + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.sms module +--------------------------------------- + +.. automodule:: webdriver.extensions.android.sms + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.android.system\_bars module +------------------------------------------------ + +.. automodule:: webdriver.extensions.android.system_bars + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: webdriver.extensions.android + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/webdriver.extensions.rst b/docs/webdriver.extensions.rst new file mode 100644 index 000000000..53002b3a9 --- /dev/null +++ b/docs/webdriver.extensions.rst @@ -0,0 +1,158 @@ +webdriver.extensions package +============================ + +Subpackages +----------- + +.. toctree:: + + webdriver.extensions.android + webdriver.extensions.search_context + +Submodules +---------- + +webdriver.extensions.action\_helpers module +------------------------------------------- + +.. automodule:: webdriver.extensions.action_helpers + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.applications module +---------------------------------------- + +.. automodule:: webdriver.extensions.applications + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.clipboard module +------------------------------------- + +.. automodule:: webdriver.extensions.clipboard + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.context module +----------------------------------- + +.. automodule:: webdriver.extensions.context + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.device\_time module +---------------------------------------- + +.. automodule:: webdriver.extensions.device_time + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.execute\_driver module +------------------------------------------- + +.. automodule:: webdriver.extensions.execute_driver + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.execute\_mobile\_command module +---------------------------------------------------- + +.. automodule:: webdriver.extensions.execute_mobile_command + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.hw\_actions module +--------------------------------------- + +.. automodule:: webdriver.extensions.hw_actions + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.images\_comparison module +---------------------------------------------- + +.. automodule:: webdriver.extensions.images_comparison + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.ime module +------------------------------- + +.. automodule:: webdriver.extensions.ime + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.keyboard module +------------------------------------ + +.. automodule:: webdriver.extensions.keyboard + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.location module +------------------------------------ + +.. automodule:: webdriver.extensions.location + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.log\_event module +-------------------------------------- + +.. automodule:: webdriver.extensions.log_event + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.remote\_fs module +-------------------------------------- + +.. automodule:: webdriver.extensions.remote_fs + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.screen\_record module +------------------------------------------ + +.. automodule:: webdriver.extensions.screen_record + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.session module +----------------------------------- + +.. automodule:: webdriver.extensions.session + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.settings module +------------------------------------ + +.. automodule:: webdriver.extensions.settings + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: webdriver.extensions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/webdriver.extensions.search_context.rst b/docs/webdriver.extensions.search_context.rst new file mode 100644 index 000000000..cff8b87eb --- /dev/null +++ b/docs/webdriver.extensions.search_context.rst @@ -0,0 +1,62 @@ +webdriver.extensions.search\_context package +============================================ + +Submodules +---------- + +webdriver.extensions.search\_context.android module +--------------------------------------------------- + +.. automodule:: webdriver.extensions.search_context.android + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.search\_context.base\_search\_context module +----------------------------------------------------------------- + +.. automodule:: webdriver.extensions.search_context.base_search_context + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.search\_context.custom module +-------------------------------------------------- + +.. automodule:: webdriver.extensions.search_context.custom + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.search\_context.ios module +----------------------------------------------- + +.. automodule:: webdriver.extensions.search_context.ios + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.search\_context.mobile module +-------------------------------------------------- + +.. automodule:: webdriver.extensions.search_context.mobile + :members: + :undoc-members: + :show-inheritance: + +webdriver.extensions.search\_context.windows module +--------------------------------------------------- + +.. automodule:: webdriver.extensions.search_context.windows + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: webdriver.extensions.search_context + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/webdriver.rst b/docs/webdriver.rst new file mode 100644 index 000000000..2b20f6b26 --- /dev/null +++ b/docs/webdriver.rst @@ -0,0 +1,102 @@ +webdriver package +================= + +Subpackages +----------- + +.. toctree:: + + webdriver.common + webdriver.extensions + +Submodules +---------- + +webdriver.appium\_connection module +----------------------------------- + +.. automodule:: webdriver.appium_connection + :members: + :undoc-members: + :show-inheritance: + +webdriver.appium\_service module +-------------------------------- + +.. automodule:: webdriver.appium_service + :members: + :undoc-members: + :show-inheritance: + +webdriver.applicationstate module +--------------------------------- + +.. automodule:: webdriver.applicationstate + :members: + :undoc-members: + :show-inheritance: + +webdriver.clipboard\_content\_type module +----------------------------------------- + +.. automodule:: webdriver.clipboard_content_type + :members: + :undoc-members: + :show-inheritance: + +webdriver.connectiontype module +------------------------------- + +.. automodule:: webdriver.connectiontype + :members: + :undoc-members: + :show-inheritance: + +webdriver.errorhandler module +----------------------------- + +.. automodule:: webdriver.errorhandler + :members: + :undoc-members: + :show-inheritance: + +webdriver.mobilecommand module +------------------------------ + +.. automodule:: webdriver.mobilecommand + :members: + :undoc-members: + :show-inheritance: + +webdriver.switch\_to module +--------------------------- + +.. automodule:: webdriver.switch_to + :members: + :undoc-members: + :show-inheritance: + +webdriver.webdriver module +-------------------------- + +.. automodule:: webdriver.webdriver + :members: + :undoc-members: + :show-inheritance: + +webdriver.webelement module +--------------------------- + +.. automodule:: webdriver.webelement + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: webdriver + :members: + :undoc-members: + :show-inheritance: From 6b062a74f1906d72beece86baa96d0facd453fdf Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 15:37:25 +0900 Subject: [PATCH 04/12] Update settings --- .gitignore | 3 ++- docs/Makefile | 4 ++-- docs/README.md | 21 +++++++++++++++++++++ docs/conf.py | 2 +- docs/index.rst | 2 +- 5 files changed, 27 insertions(+), 5 deletions(-) create mode 100644 docs/README.md diff --git a/.gitignore b/.gitignore index c5b30b794..e4760485b 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ *._* *.log *.log.* +_*/ *.pyc *.egg-info @@ -23,4 +24,4 @@ __pycache__ venv* .tox -Pipfile.lock \ No newline at end of file +Pipfile.lock diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf10..d4bb2cbb9 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,8 +5,8 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build +SOURCEDIR = . +BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..58cd3fb6b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,21 @@ +### How to generate doc + +```bash +$cd python-client +$sphinx-apidoc -F -o docs/ appium/webdriver +$cd docs +$make html +``` + +### How to check generated doc + +```bash +$cd python-client/docs/_build/html +$python -m http.server 1234 +``` + +Access to `http://localhost:1234` on web browser + + +### Deploy generated doc +To be updated \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 3c72ef291..795a0d279 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('../appium/webdriver')) +sys.path.insert(0, os.path.abspath('../appium')) # -- Project information ----------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 61c44c180..a7900e31b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. webdriver documentation master file, created by - sphinx-quickstart on Mon Feb 24 15:05:47 2020. + sphinx-quickstart on Mon Feb 24 15:27:21 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. From 30522c7d7e03037a6c8585cbff4390eea71b1d48 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 15:56:31 +0900 Subject: [PATCH 05/12] Change project name --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 795a0d279..cc167023c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,12 +18,12 @@ # -- Project information ----------------------------------------------------- -project = 'python_client_doc' +project = 'Python client 1.0beta' copyright = '2020, Appium' author = 'Appium' # The full version, including alpha/beta/rc tags -release = '1.0.0' +release = '1.0beta' # -- General configuration --------------------------------------------------- From bee9466ab1f2ae83d65c534cbc056c435cfd4312 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 17:24:21 +0900 Subject: [PATCH 06/12] Add script to generate docs --- docs/README.md | 12 ++++++------ docs/generate.sh | 3 +++ 2 files changed, 9 insertions(+), 6 deletions(-) create mode 100644 docs/generate.sh diff --git a/docs/README.md b/docs/README.md index 58cd3fb6b..119c85153 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,15 @@ ### How to generate doc ```bash -$cd python-client -$sphinx-apidoc -F -o docs/ appium/webdriver -$cd docs -$make html +$cd python-client/docs +$bash generate.sh ``` ### How to check generated doc ```bash +$cd python-client/docs +$bash generate.sh $cd python-client/docs/_build/html $python -m http.server 1234 ``` @@ -17,5 +17,5 @@ $python -m http.server 1234 Access to `http://localhost:1234` on web browser -### Deploy generated doc -To be updated \ No newline at end of file +### How to deploy generated doc +See https://github.com/ki4070ma/python-client-sphinx#how-to-deploy for now diff --git a/docs/generate.sh b/docs/generate.sh new file mode 100644 index 000000000..601267fab --- /dev/null +++ b/docs/generate.sh @@ -0,0 +1,3 @@ +#!/bin/sh +sphinx-apidoc -F -o . ../appium/webdriver +make html From 68fb534cbabc6883451450c47ee2ce5a9c02a326 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 20:54:29 +0900 Subject: [PATCH 07/12] Changed header title --- docs/generate.sh | 3 ++- docs/index.rst | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/generate.sh b/docs/generate.sh index 601267fab..219b7325d 100644 --- a/docs/generate.sh +++ b/docs/generate.sh @@ -1,3 +1,4 @@ #!/bin/sh -sphinx-apidoc -F -o . ../appium/webdriver +rm -rf *rst _build +sphinx-apidoc -F -H 'Appium python client' -o . ../appium/webdriver make html diff --git a/docs/index.rst b/docs/index.rst index a7900e31b..9542dd322 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,10 @@ -.. webdriver documentation master file, created by - sphinx-quickstart on Mon Feb 24 15:27:21 2020. +.. Appium python client documentation master file, created by + sphinx-quickstart on Mon Feb 24 20:53:27 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to webdriver's documentation! -===================================== +Welcome to Appium python client's documentation! +================================================ .. toctree:: :maxdepth: 4 From 15fad284013670fb2b3725e7461c3769efc7d42f Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 21:33:46 +0900 Subject: [PATCH 08/12] Add new line to usage section --- appium/webdriver/common/multi_action.py | 16 ++++++++-------- appium/webdriver/extensions/android/power.py | 2 +- appium/webdriver/extensions/device_time.py | 2 +- appium/webdriver/extensions/execute_driver.py | 4 ++-- appium/webdriver/extensions/log_event.py | 2 +- appium/webdriver/webelement.py | 4 ++-- docs/index.rst | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/appium/webdriver/common/multi_action.py b/appium/webdriver/common/multi_action.py index e6a84cfec..9435d00d8 100644 --- a/appium/webdriver/common/multi_action.py +++ b/appium/webdriver/common/multi_action.py @@ -44,10 +44,10 @@ def add(self, *touch_actions: 'TouchAction') -> None: touch_actions (`TouchAction`): one or more TouchAction objects describing a chain of actions to be performed by one finger Usage: - a1 = TouchAction(driver) - a1.press(el1).move_to(el2).release() - a2 = TouchAction(driver) - a2.press(el2).move_to(el1).release() + a1 = TouchAction(driver)\n + a1.press(el1).move_to(el2).release()\n + a2 = TouchAction(driver)\n + a2.press(el2).move_to(el1).release()\n MultiAction(driver).add(a1, a2) """ @@ -61,10 +61,10 @@ def perform(self: T) -> T: """Perform the actions stored in the object. Usage: - a1 = TouchAction(driver) - a1.press(el1).move_to(el2).release() - a2 = TouchAction(driver) - a2.press(el2).move_to(el1).release() + a1 = TouchAction(driver)\n + a1.press(el1).move_to(el2).release()\n + a2 = TouchAction(driver)\n + a2.press(el2).move_to(el1).release()\n MultiAction(driver).add(a1, a2).perform() """ diff --git a/appium/webdriver/extensions/android/power.py b/appium/webdriver/extensions/android/power.py index 827324e8f..259b6871f 100644 --- a/appium/webdriver/extensions/android/power.py +++ b/appium/webdriver/extensions/android/power.py @@ -51,7 +51,7 @@ def set_power_ac(self, ac_state: str) -> T: ac_state (str): The power ac state to be set. Use `.AC_OFF`, `.AC_ON` Usage: - self.driver.set_power_ac(Power.AC_OFF) + self.driver.set_power_ac(Power.AC_OFF)\n self.driver.set_power_ac(Power.AC_ON) Returns: diff --git a/appium/webdriver/extensions/device_time.py b/appium/webdriver/extensions/device_time.py index d16f56b3f..3f6b39d7a 100644 --- a/appium/webdriver/extensions/device_time.py +++ b/appium/webdriver/extensions/device_time.py @@ -40,7 +40,7 @@ def get_device_time(self, format: Optional[str] = None) -> str: which complies to ISO-8601 Usage: - self.driver.get_device_time() + self.driver.get_device_time()\n self.driver.get_device_time("YYYY-MM-DD") Return: diff --git a/appium/webdriver/extensions/execute_driver.py b/appium/webdriver/extensions/execute_driver.py index 3b3778c39..b6962f57a 100644 --- a/appium/webdriver/extensions/execute_driver.py +++ b/appium/webdriver/extensions/execute_driver.py @@ -33,8 +33,8 @@ def execute_driver(self, script: str, script_type: str = 'webdriverio', timeout_ timeout_ms (:obj:`int`, optional): The number of `ms` Appium should wait for the script to finish before killing it due to timeout_ms. Usage: - self.driver.execute_driver(script='return [];') - self.driver.execute_driver(script='return [];', script_type='webdriverio') + self.driver.execute_driver(script='return [];')\n + self.driver.execute_driver(script='return [];', script_type='webdriverio')\n self.driver.execute_driver(script='return [];', script_type='webdriverio', timeout_ms=10000) Returns: diff --git a/appium/webdriver/extensions/log_event.py b/appium/webdriver/extensions/log_event.py index b22c2416b..0a910d2aa 100644 --- a/appium/webdriver/extensions/log_event.py +++ b/appium/webdriver/extensions/log_event.py @@ -31,7 +31,7 @@ def get_events(self, type: List[str] = None) -> Dict[str, Union[str, int]]: type (:obj:`list` of :obj:`str`): The event type to filter with Usage: - events = driver.get_events() + events = driver.get_events()\n events = driver.get_events(['appium:funEvent']) Returns: diff --git a/appium/webdriver/webelement.py b/appium/webdriver/webelement.py index ce9e8f808..765c3a76f 100644 --- a/appium/webdriver/webelement.py +++ b/appium/webdriver/webelement.py @@ -179,8 +179,8 @@ def location_in_view(self) -> Dict[str, int]: """Gets the location of an element relative to the view. Usage: - location = element.location_in_view - x = location['x'] + location = element.location_in_view\n + x = location['x']\n y = location['y'] Returns: diff --git a/docs/index.rst b/docs/index.rst index 9542dd322..f7ee6bb0a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. Appium python client documentation master file, created by - sphinx-quickstart on Mon Feb 24 20:53:27 2020. + sphinx-quickstart on Mon Feb 24 21:32:59 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. From a97f2c88322c554185291f6b5fce986387ded03e Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Mon, 24 Feb 2020 23:13:02 +0900 Subject: [PATCH 09/12] Add py.typed file(PEP561) --- appium/webdriver/py.typed | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 appium/webdriver/py.typed diff --git a/appium/webdriver/py.typed b/appium/webdriver/py.typed new file mode 100644 index 000000000..e69de29bb From 234d6de4badfb27642eb35585d381fbb7a61592a Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Sun, 1 Mar 2020 16:18:27 +0900 Subject: [PATCH 10/12] Replace \n with new line --- appium/webdriver/common/multi_action.py | 22 ++++++++++++------- appium/webdriver/extensions/android/power.py | 3 ++- appium/webdriver/extensions/device_time.py | 3 ++- appium/webdriver/extensions/execute_driver.py | 6 +++-- appium/webdriver/extensions/log_event.py | 3 ++- appium/webdriver/webelement.py | 6 +++-- 6 files changed, 28 insertions(+), 15 deletions(-) diff --git a/appium/webdriver/common/multi_action.py b/appium/webdriver/common/multi_action.py index 9435d00d8..692decad0 100644 --- a/appium/webdriver/common/multi_action.py +++ b/appium/webdriver/common/multi_action.py @@ -44,10 +44,13 @@ def add(self, *touch_actions: 'TouchAction') -> None: touch_actions (`TouchAction`): one or more TouchAction objects describing a chain of actions to be performed by one finger Usage: - a1 = TouchAction(driver)\n - a1.press(el1).move_to(el2).release()\n - a2 = TouchAction(driver)\n - a2.press(el2).move_to(el1).release()\n + a1 = TouchAction(driver) + + a1.press(el1).move_to(el2).release() + + a2 = TouchAction(driver) + + a2.press(el2).move_to(el1).release() MultiAction(driver).add(a1, a2) """ @@ -61,10 +64,13 @@ def perform(self: T) -> T: """Perform the actions stored in the object. Usage: - a1 = TouchAction(driver)\n - a1.press(el1).move_to(el2).release()\n - a2 = TouchAction(driver)\n - a2.press(el2).move_to(el1).release()\n + a1 = TouchAction(driver) + + a1.press(el1).move_to(el2).release() + + a2 = TouchAction(driver) + + a2.press(el2).move_to(el1).release() MultiAction(driver).add(a1, a2).perform() """ diff --git a/appium/webdriver/extensions/android/power.py b/appium/webdriver/extensions/android/power.py index 259b6871f..381e597b0 100644 --- a/appium/webdriver/extensions/android/power.py +++ b/appium/webdriver/extensions/android/power.py @@ -51,7 +51,8 @@ def set_power_ac(self, ac_state: str) -> T: ac_state (str): The power ac state to be set. Use `.AC_OFF`, `.AC_ON` Usage: - self.driver.set_power_ac(Power.AC_OFF)\n + self.driver.set_power_ac(Power.AC_OFF) + self.driver.set_power_ac(Power.AC_ON) Returns: diff --git a/appium/webdriver/extensions/device_time.py b/appium/webdriver/extensions/device_time.py index 3f6b39d7a..db57f19c2 100644 --- a/appium/webdriver/extensions/device_time.py +++ b/appium/webdriver/extensions/device_time.py @@ -40,7 +40,8 @@ def get_device_time(self, format: Optional[str] = None) -> str: which complies to ISO-8601 Usage: - self.driver.get_device_time()\n + self.driver.get_device_time() + self.driver.get_device_time("YYYY-MM-DD") Return: diff --git a/appium/webdriver/extensions/execute_driver.py b/appium/webdriver/extensions/execute_driver.py index b6962f57a..4e96b8feb 100644 --- a/appium/webdriver/extensions/execute_driver.py +++ b/appium/webdriver/extensions/execute_driver.py @@ -33,8 +33,10 @@ def execute_driver(self, script: str, script_type: str = 'webdriverio', timeout_ timeout_ms (:obj:`int`, optional): The number of `ms` Appium should wait for the script to finish before killing it due to timeout_ms. Usage: - self.driver.execute_driver(script='return [];')\n - self.driver.execute_driver(script='return [];', script_type='webdriverio')\n + self.driver.execute_driver(script='return [];') + + self.driver.execute_driver(script='return [];', script_type='webdriverio') + self.driver.execute_driver(script='return [];', script_type='webdriverio', timeout_ms=10000) Returns: diff --git a/appium/webdriver/extensions/log_event.py b/appium/webdriver/extensions/log_event.py index 0a910d2aa..d7de2eca2 100644 --- a/appium/webdriver/extensions/log_event.py +++ b/appium/webdriver/extensions/log_event.py @@ -31,7 +31,8 @@ def get_events(self, type: List[str] = None) -> Dict[str, Union[str, int]]: type (:obj:`list` of :obj:`str`): The event type to filter with Usage: - events = driver.get_events()\n + events = driver.get_events() + events = driver.get_events(['appium:funEvent']) Returns: diff --git a/appium/webdriver/webelement.py b/appium/webdriver/webelement.py index 765c3a76f..2eb191aa9 100644 --- a/appium/webdriver/webelement.py +++ b/appium/webdriver/webelement.py @@ -179,8 +179,10 @@ def location_in_view(self) -> Dict[str, int]: """Gets the location of an element relative to the view. Usage: - location = element.location_in_view\n - x = location['x']\n + location = element.location_in_view + + x = location['x'] + y = location['y'] Returns: From 726696c887e3a7e3ad206bc573ced801db36be1b Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Sun, 1 Mar 2020 16:20:08 +0900 Subject: [PATCH 11/12] tweak --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index cc167023c..7d93d15da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- -project = 'Python client 1.0beta' +project = 'Python client 1.0 beta' copyright = '2020, Appium' author = 'Appium' From 1ba0678d0c2faf56712557d0cb7b6baada21ad68 Mon Sep 17 00:00:00 2001 From: Atsushi Mori Date: Sun, 1 Mar 2020 17:07:00 +0900 Subject: [PATCH 12/12] Use sphinx format for tables --- appium/webdriver/connectiontype.py | 22 +++++++++++++------ .../webdriver/extensions/android/network.py | 22 +++++++++++++------ docs/index.rst | 2 +- 3 files changed, 31 insertions(+), 15 deletions(-) diff --git a/appium/webdriver/connectiontype.py b/appium/webdriver/connectiontype.py index 7d477680e..7db69ba36 100644 --- a/appium/webdriver/connectiontype.py +++ b/appium/webdriver/connectiontype.py @@ -16,13 +16,21 @@ """ Connection types are specified here: https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile#120 - Value (Alias) | Data | Wifi | Airplane Mode - ------------------------------------------------- - 0 (None) | 0 | 0 | 0 - 1 (Airplane Mode) | 0 | 0 | 1 - 2 (Wifi only) | 0 | 1 | 0 - 4 (Data only) | 1 | 0 | 0 - 6 (All network on) | 1 | 1 | 0 + + +--------------------+------+------+---------------+ + | Value (Alias) | Data | Wifi | Airplane Mode | + +====================+======+======+===============+ + | 0 (None) | 0 | 0 | 0 | + +--------------------+------+------+---------------+ + | 1 (Airplane Mode) | 0 | 0 | 1 | + +--------------------+------+------+---------------+ + | 2 (Wifi only) | 0 | 1 | 0 | + +--------------------+------+------+---------------+ + | 4 (Data only) | 1 | 0 | 0 | + +--------------------+------+------+---------------+ + | 6 (All network on) | 1 | 1 | 0 | + +--------------------+------+------+---------------+ + """ diff --git a/appium/webdriver/extensions/android/network.py b/appium/webdriver/extensions/android/network.py index 4f8746875..d95bc4400 100644 --- a/appium/webdriver/extensions/android/network.py +++ b/appium/webdriver/extensions/android/network.py @@ -50,13 +50,21 @@ def set_network_connection(self, connection_type: int) -> int: """Sets the network connection type. Android only. Possible values: - Value (Alias) | Data | Wifi | Airplane Mode - ------------------------------------------------- - 0 (None) | 0 | 0 | 0 - 1 (Airplane Mode) | 0 | 0 | 1 - 2 (Wifi only) | 0 | 1 | 0 - 4 (Data only) | 1 | 0 | 0 - 6 (All network on) | 1 | 1 | 0 + + +--------------------+------+------+---------------+ + | Value (Alias) | Data | Wifi | Airplane Mode | + +====================+======+======+===============+ + | 0 (None) | 0 | 0 | 0 | + +--------------------+------+------+---------------+ + | 1 (Airplane Mode) | 0 | 0 | 1 | + +--------------------+------+------+---------------+ + | 2 (Wifi only) | 0 | 1 | 0 | + +--------------------+------+------+---------------+ + | 4 (Data only) | 1 | 0 | 0 | + +--------------------+------+------+---------------+ + | 6 (All network on) | 1 | 1 | 0 | + +--------------------+------+------+---------------+ + These are available through the enumeration `appium.webdriver.ConnectionType` Args: diff --git a/docs/index.rst b/docs/index.rst index f7ee6bb0a..b5db08cc5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. Appium python client documentation master file, created by - sphinx-quickstart on Mon Feb 24 21:32:59 2020. + sphinx-quickstart on Sun Mar 1 17:05:15 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.