For homework 4

1_hw/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2018 The Python Packaging Authority
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

1_hw/README.md

@@ -1,33 +0,0 @@
-# Test package
-
-## Sequence of commands for creating a virtual environment:
-```
->> mkdir YOUR_PACKAGE_NAME
->> cd YOUR_PACKAGE_NAME
->> touch __init__.py
->> cd ..
->> touch pyproject.toml
->> open pyproject.toml
-...
->> touch LICENSE
->> open LICENSE
-...
->> touch README.md
->> open README.md
-...
->> python3 -m build
-```
-
-## Creating documentation using sphinx:
-```
->> mkdir docs
->> cd docs
->> sphinx-quickstart
->> ...
->> touch views.py
->> open views.py
->> ...
->> cd source
->> open index.rst
->> ...
-```

1_hw/controls_Ermakov/__init__.py

@@ -1 +0,0 @@
-"""It's docstring!"""

1_hw/docs/Makefile

@@ -1,20 +0,0 @@
-# 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)

1_hw/docs/conf.py

@@ -1,28 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'controls_Ermakov'
-copyright = '2023, Ermakov Alexey'
-author = 'Ermakov Alexey'
-release = '0.0.1'
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = []
-
-templates_path = ['_templates']
-exclude_patterns = []
-
-language = 'python3'
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = 'alabaster'
-html_static_path = ['_static']

1_hw/docs/index.rst

@@ -1,29 +0,0 @@
-.. controls_Ermakov documentation master file, created by
-   sphinx-quickstart on Fri Sep 29 17:02:16 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to controls_Ermakov's documentation!
-============================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-Documentation myproject
-======================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: example of automatic-generative docs views
-
-   ./views.rst

1_hw/docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-%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.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

1_hw/docs/views.rst

@@ -1,6 +0,0 @@
-Views
-=====
-
-.. automodule:: test_app.views
-   :members:
-   :undoc-members:

1_hw/pyproject.toml

@@ -1,22 +0,0 @@
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name = "controls_Ermakov"
-version = "0.0.1"
-description = "Homework project"
-authors = ["Ermakov Alexey <[ermakov.ad@phystech.edu]>"]
-license = "MIT"
-
-[tool.poetry.dependencies]
-python = "^3.8"
-
-[tool.poetry.dev-dependencies]
-pytest = "^4.6"
-Pylint = "^2.0"
-MyPy = "^1.2"
-
-[tool.poetry.extras]
-docs = ["sphinx"]
-extensions = ["sphinx.ext.autodoc"]

2_hw/with_numpy.py

@@ -1,24 +0,0 @@
-import time
-import numpy as np
-
-def mandelbrot(pmin = -2.5, pmax = 1.5, qmin = -2, qmax = 2,
-            ppoints = 200, qpoints = 200, max_iterations = 300, infinity_border= 100):
-
-    image = np.zeros((ppoints, qpoints))
-
-    for ip, p in enumerate(np.linspace(pmin, pmax, ppoints)):
-        for iq, q in enumerate(np.linspace(qmin, qmax, qpoints)):
-            c = p + 1j * q
-            z = 0
-            for k in range(max_iterations):
-                z = z ** 2 + c
-                if abs(z) > infinity_border:
-
-                    image[ip, iq] = 1
-                    break
-    return image
-
-tic = time.perf_counter_ns()
-image = mandelbrot()
-toc = time.perf_counter_ns()
-print((toc - tic)/1_000_000_000, "s")

2_hw/with_typing_hints.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-import time
-
-def linspace(start, stop, n):
-    if n == 1:
-        yield stop
-        return
-    h = (stop - start) / (n - 1)
-    for i in range(n):
-        yield start + h * i
-
-def mandelbrot(pmin: float = -2.5, pmax: float = 1.5, qmin: float = -2, qmax: float = 2,
-                ppoints: int = 200, qpoints: int = 200, max_iterations: int = 300, infinity_border: float = 100) -> list[list[int]]:
-
-    image: list[list[int]] = [[0 for i in range(qpoints)] for j in range(ppoints)]
-    for ip, p in enumerate(linspace(pmin, pmax, ppoints)):
-        for iq, q in enumerate(linspace(qmin, qmax, qpoints)):
-            c: complex = p + 1j * q
-            z: complex  = 0
-            for k in range(max_iterations):
-                z = z ** 2 + c
-                if abs(z) > infinity_border:
-                    image[ip][iq] = 1
-                    break
-    return image
-
-tic = time.perf_counter_ns()
-image = mandelbrot()
-toc = time.perf_counter_ns()
-print((toc - tic)/1_000_000_000, "s")

2_hw/without_typing_hints.py

@@ -1,28 +0,0 @@
-import time
-
-def linspace(start, stop, n):
-    if n == 1:
-        yield stop
-        return
-    h = (stop - start) / (n - 1)
-    for i in range(n):
-        yield start + h * i
-
-def mandelbrot(pmin = -2.5, pmax= 1.5, qmin = -2, qmax= 2,
-                ppoints = 200, qpoints = 200, max_iterations = 300, infinity_border = 100):
-    image = [[0 for i in range(qpoints)] for j in range(ppoints)]
-    for ip, p in enumerate(linspace(pmin, pmax, ppoints)):
-        for iq, q in enumerate(linspace(qmin, qmax, qpoints)):
-            c = p + 1j * q
-            z = 0
-            for k in range(max_iterations):
-                z = z ** 2 + c
-                if abs(z) > infinity_border:
-                    image[ip][iq] = 1
-                    break
-    return image
-
-tic = time.perf_counter_ns()
-image = mandelbrot()
-toc = time.perf_counter_ns()
-print((toc - tic)/1_000_000_000, "s")

controls/device.py

@@ -0,0 +1,82 @@
+from dataclasses import dataclass
+from typing import Optional, Collection, Any
+from abc import abstractmethod
+
+class DeviceLifecycleState:
+    pass  # TODO(Homework #3)
+
+
+class DevaceError(Exception):
+    pass
+
+
+class NonReadableTrait(Exception):
+    pass
+
+
+class NonWritableTrait(Exception):
+    pass
+
+
+@dataclass
+class TraitDescriptor:
+    name: str
+    info: Optional[str] = None
+    readable: bool = True
+    writable: bool = False
+
+
+@dataclass
+class ActionDescriptor:
+    name: str
+    arguments: dict[str, type]
+    info: Optional[str] = None
+
+
+class Device:
+    # TODO(Homework #3)
+    _state = DeviceLifecycleState.INIT
+
+    @property
+    def state(self) -> DeviceLifecycleState:
+        return self._state
+
+    def close(self):
+        self._state = DeviceLifecycleState.CLOSE
+
+    def trait_descriptors(self) -> Collection[TraitDescriptor]:
+        pass
+
+    def action_descriptors(self) -> Collection[ActionDescriptor]:
+        pass
+
+    @abstractmethod
+    def __getitem__(self, trait_name: str) -> Optional[Any]:
+        """Return logical state of trait `trait_name`."""
+        pass
+
+
+class SynchronyDevice(Device):
+
+    def open(self):
+        self._state = DeviceLifecycleState.OPEN
+
+    @abstractmethod
+    def execute(self, action_name: str, *args, **kwargs):
+        """Execute action `action_name`, using `args` and `kwargs` as action argument."""
+        pass
+
+    @abstractmethod
+    def read(self, trait_name: str) -> Any:
+        """Read physical state of trait `trait_name` from device."""
+        raise NonReadableTrait
+
+    @abstractmethod
+    def write(self, trait_name: str, value: Any) -> bool:
+        """Pass `value` to trait `trait_name` of device."""
+        raise NonWritableTrait
+
+    @abstractmethod
+    def invalidate(self, trait_name: str):
+        """Invalidate logical state of trait `trait_name`"""
+        pass

equipment/turtle_device.py

@@ -0,0 +1,8 @@
+from turtle import Turtle
+from controls.device import SynchronyDevice
+
+class TurtleDevice(SynchronyDevice):
+    pass  # TODO(Homework #3)
+
+
+

noblocking_turtle_shell.py

@@ -0,0 +1,35 @@
+import cmd
+import threading
+
+from queue import Queue
+
+from equipment.turtle_device import TurtleDevice
+
+
+class TurtleDeviceThread(threading.Thread):
+    # TODO(Homework 4)
+    def __init__(self):
+        super().__init__()
+        self.device = TurtleDevice()
+        self.queue = Queue()
+
+
+class NoBlockingTurtleShell(cmd.Cmd):
+    intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
+    prompt = '(turtle) '
+    file = None
+
+    def __init__(self, turtle_thread: TurtleDeviceThread):
+        pass  # TODO(Homework 4)
+
+    def do_execute(self, arg):
+        pass  # TODO(Homework 4)
+
+    def do_exit(self, arg):
+        pass  # TODO(Homework 4)
+
+
+if __name__ == '__main__':
+    turtle_thread = TurtleDeviceThread()
+    # TODO(Homework 4: Correct start thread)
+    NoBlockingTurtleShell(turtle_thread).cmdloop()

tests/controls/test_device.py

@@ -0,0 +1,12 @@
+from unittest import TestCase
+
+from controls.device import DeviceLifecycleState
+
+
+class DeviceLifecycleStateTest(TestCase):
+
+    def setUp(self) -> None:
+        pass
+
+    def test_enum(self):
+        self.assertEqual(DeviceLifecycleStateTest["INIT"], DeviceLifecycleStateTest.INIT)

tests/equipment/test_turtle_device.py

@@ -0,0 +1,13 @@
+from unittest import TestCase
+
+from equipment.turtle_device import TurtleDevice
+
+
+class TurtleDeviceTest(TestCase):
+
+    def setUp(self) -> None:
+        self.device = TurtleDevice()
+
+    def test_open(self):
+        self.device.open()
+        self.device.close()

turtle_shell.py

@@ -0,0 +1,74 @@
+import cmd, sys
+from turtle import *
+
+
+class TurtleShell(cmd.Cmd):
+    intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
+    prompt = '(turtle) '
+    file = None
+
+    # ----- basic turtle commands -----
+    def do_forward(self, arg):
+        'Move the turtle forward by the specified distance:  FORWARD 10'
+        forward(*parse(arg))
+    def do_right(self, arg):
+        'Turn turtle right by given number of degrees:  RIGHT 20'
+        right(*parse(arg))
+    def do_left(self, arg):
+        'Turn turtle left by given number of degrees:  LEFT 90'
+        left(*parse(arg))
+    def do_goto(self, arg):
+        'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
+        goto(*parse(arg))
+    def do_home(self, arg):
+        'Return turtle to the home position:  HOME'
+        home()
+    def do_circle(self, arg):
+        'Draw circle with given radius an options extent and steps:  CIRCLE 50'
+        circle(*parse(arg))
+    def do_position(self, arg):
+        'Print the current turtle position:  POSITION'
+        print('Current position is %d %d\n' % position())
+    def do_heading(self, arg):
+        'Print the current turtle heading in degrees:  HEADING'
+        print('Current heading is %d\n' % (heading(),))
+    def do_color(self, arg):
+        'Set the color:  COLOR BLUE'
+        color(arg.lower())
+    def do_undo(self, arg):
+        'Undo (repeatedly) the last turtle action(s):  UNDO'
+    def do_reset(self, arg):
+        'Clear the screen and return turtle to center:  RESET'
+        reset()
+    def do_bye(self, arg):
+        'Stop recording, close the turtle window, and exit:  BYE'
+        print('Thank you for using Turtle')
+        self.close()
+        bye()
+        return True
+
+    # ----- record and playback -----
+    def do_record(self, arg):
+        'Save future commands to filename:  RECORD rose.cmd'
+        self.file = open(arg, 'w')
+    def do_playback(self, arg):
+        'Playback commands from a file:  PLAYBACK rose.cmd'
+        self.close()
+        with open(arg) as f:
+            self.cmdqueue.extend(f.read().splitlines())
+    def precmd(self, line):
+        line = line.lower()
+        if self.file and 'playback' not in line:
+            print(line, file=self.file)
+        return line
+    def close(self):
+        if self.file:
+            self.file.close()
+            self.file = None
+
+def parse(arg):
+    'Convert a series of zero or more numbers to an argument tuple'
+    return tuple(map(int, arg.split()))
+
+if __name__ == '__main__':
+    TurtleShell().cmdloop()