Merge pull request #5 from W-A-L-L-3/develop

v1.0.0

Author: Yu-Leo

.gitignore

@@ -127,3 +127,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Ignore PyCharm files
+.idea/
+
+#Ignore storehouse model file
+storehouse.pickle

API/README.md

@@ -0,0 +1,21 @@
+# ppo_it_5_2021
+
+## Сервис для моделирования аппаратной части электронного скада
+
+Для установки зависимостей:
+
+```bash
+pip3 install -r requirements.txt
+```
+
+Запуск:
+
+```bash
+python3 app.py
+```
+
+При запуске создается случайным образом схема вертикального склада.
+
+Приложение по умолчанию запускается на `localhost:5000`.
+
+Для изменения адреса и порта воспользуйтесь документацией [flask](https://flask.palletsprojects.com/en/1.1.x/).

API/__init__.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+import json
+
+from flask import Flask, request
+
+from storage import Storage
+
+app = Flask(__name__)
+
+
+@app.route('/scheme', methods=['GET'])
+def index():
+    return json.dumps(st.storageStructure)
+
+
+@app.route('/', methods=['POST'])
+def addItems():
+    putData = request.get_json()
+    addItemsResponse = True
+    for item in putData:
+        localResponse = st.putInStorage(item['uuid'], item['destination'])
+        if localResponse is False:
+            addItemsResponse = False
+    if addItemsResponse is True:
+        return {"status": "ok"}
+    else:
+        return {"status": "error"}, 400
+
+
+@app.route('/position', methods=['GET'])
+def getItems():
+    destination = request.args.getlist('destination')
+    getItemsResponse = st.getFromStorage(destination)
+    if getItemsResponse >= 0:
+        return {"status": "ok"}
+    elif getItemsResponse == -1:
+        return {"status": "position is empty"}, 404
+    elif getItemsResponse == -2:
+        return {"status": "position does not exist"}, 400
+
+
+if __name__ == '__main__':
+    st = Storage()
+    st.generateStorage()
+    app.run(debug=True)

API/app.py

@@ -0,0 +1,143 @@
+from random import randint
+
+MIN_SIZE = 3
+MAX_SIZE = 9
+MIN_MERGED_CELLS = 2
+
+QUAD_CELLS = 4
+DOUBLE_CELLS = 2
+
+
+class Storage:
+    def __init__(self):
+        self.x = 0
+        self.y = 0
+        self.z = 0
+        self.mergedCells = []
+        self.busyCells = []
+        self.storageStructure = {
+            'size': {},
+            'merged': []
+        }
+
+    def setStorageSizes(self, x, y, z):
+        if x > 0 and y > 0 and z > 0:
+            self.x = int(x)
+            self.y = int(y)
+            self.z = int(z)
+            self.storageStructure['size']['size_x'] = self.x
+            self.storageStructure['size']['size_y'] = self.y
+            self.storageStructure['size']['size_z'] = self.z
+
+    def changeCellName(self, x, y):
+        return chr(ord(str(x)) + 16) + str(y)
+
+    def setStorageMergedCells(self, cellsList):
+        addedList = []
+        for i in range(0, len(cellsList) - 1, 2):
+            self.mergedCells.append([cellsList[i], cellsList[i + 1]])
+            addedList.append(self.changeCellName(cellsList[i], cellsList[i + 1]))
+        self.storageStructure['merged'].append(sorted(addedList))
+
+    def generateRandomMergedCells(self, typeMergCells):
+        localX = max(self.x, self.z)
+        x1 = randint(1, localX)
+        y1 = randint(1, self.y)
+        x2 = x1
+        y2 = y1 + 1 if y1 < self.y else y1 - 1
+        iter = 0
+        while ([x1, y1] in self.mergedCells or [x2, y2] in self.mergedCells):
+            x1 = randint(1, localX)
+            y1 = randint(1, self.y)
+            x2 = x1
+            y2 = y1 + 1 if y1 < self.y else y1 - 1
+            iter += 1
+            if iter == 200:
+                return
+        if typeMergCells == DOUBLE_CELLS:
+            self.setStorageMergedCells([x1, y1, x2, y2])
+            return
+        if typeMergCells == QUAD_CELLS:
+            x3 = x1 + 1 if x1 < localX else x1 - 1
+            x4 = x3
+            y3 = y1
+            y4 = y2
+            if [x3, y3] in self.mergedCells or [x4, y4] in self.mergedCells:
+                return False
+            else:
+                self.setStorageMergedCells([x1, y1, x2, y2, x3, y3, x4, y4])
+                return True
+
+    def generateStorage(self):
+        typeOfStorage = 1
+        if typeOfStorage == 1:
+            self.setStorageSizes(randint(MIN_SIZE, MAX_SIZE),
+                                 randint(MIN_SIZE, MAX_SIZE), 1)
+        else:
+            self.setStorageSizes(1, randint(MIN_SIZE, MAX_SIZE),
+                                 randint(MIN_SIZE, MAX_SIZE))
+        localX = max(self.x, self.z)
+        maxQuontatyMerged = localX * self.y // 3
+        quontatyMerged = randint(MIN_MERGED_CELLS, maxQuontatyMerged)
+        quontSquadCells = quontatyMerged // 3 if quontatyMerged // 3 > 1 else 1
+        for _ in range(quontSquadCells):
+            self.generateRandomMergedCells(QUAD_CELLS)
+        for _ in range(quontatyMerged - quontSquadCells):
+            self.generateRandomMergedCells(DOUBLE_CELLS)
+        self.storageStructure['merged'].sort()
+
+    def putInStorage(self, id, destination):
+        returnCode = True
+        if destination in self.storageStructure['merged']:
+            for i in destination:
+                if i in self.busyCells:
+                    returnCode = False
+                    break
+            if returnCode is True:
+                for i in destination:
+                    self.busyCells.append(i)
+        elif len(destination) == 1:
+            strDest = destination[0]
+            x = int(chr(ord(strDest[0]) - 16))  # from symbol to int
+            y = int(strDest[1])
+            localX = max(self.x, self.z)
+            if (x <= localX and y <= self.y and
+                    strDest not in self.busyCells):
+                self.busyCells.append(strDest)
+            else:
+                returnCode = False
+        else:
+            returnCode = False
+        return returnCode
+
+    def checkCellExistence(self, cellName):
+        localX = max(self.x, self.z)
+        if len(cellName) > 2 or cellName[0] > 'I':
+            return False
+        x = int(chr(ord(cellName[0]) - 16))
+        y = int(cellName[1])
+        print(x)
+        print(y)
+        if (x <= localX and y <= self.y):
+            return True
+        else:
+            return False
+
+    def getFromStorage(self, destination):
+        returnCode = 0
+        for i in destination:
+            cellInStorageFlag = True if self.checkCellExistence(i) else False
+            if cellInStorageFlag is True:
+                if i in self.busyCells:
+                    self.busyCells.remove(i)
+                else:
+                    returnCode = -1
+            else:
+                returnCode = -2
+        return returnCode
+
+
+if __name__ == '__main__':
+    st = Storage()
+    st.generateStorage()
+    print(st.storageStructure)

API/storage.py

@@ -1,2 +1,23 @@
-# electronic-storehouse
-Московская предпрофессиональная олимпиада школьников. Профиль "Информационные технологии". Командный кейс №5 "Электронный склад"
+# Электронный склад
+
+Московская предпрофессиональная олимпиада школьников.
+
+Профиль "Информационные технологии".
+
+Командный кейс №5 "Электронный склад"
+
+[Исходный текст технического задания](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/technical-requirements.pdf)
+
+## Кратное описание
+
+Информационный сервис обеспечивающий взаимодействие пользователей (операторов) с автоматизированным складом.
+
+## Функциональность
+
+1. Добавление нескольких позиций из поставки на склад.
+2. Отображение в виде списка позиций (товаров), с указанием ячейки, в которой товар находится на складе (по запросу в
+   пользовательском интерфейсе).
+
+3. Выбора определенного товара (позиции), для осуществления выдачи его аппаратной частью.
+4. Наличие удалённого склада для позиций, которые невозможно разместить на основном складе.
+5. Отображение в виде списка позиций (товаров), находящихся на удалённом складе.

README.md

@@ -0,0 +1,11 @@
+# File with constants
+
+STOREHOUSE_FILE_NAME = 'storehouse.pickle'
+GET_PARAMS_ADDRESS = 'http://127.0.0.1:5000/scheme'
+MAX_ADDING_ITEMS = 30  # Maximum number of rows on one adding-window
+
+
+class AddingW:
+    NAME_INDEX = 1
+    SIZE_INDEX = 2
+    MASS_INDEX = 3

constants.py

@@ -0,0 +1,20 @@
+# File with my exceptions
+
+RECEIVING_ERROR = 1
+OK = 0
+
+
+class ReceivingError(Exception):
+    pass
+
+
+class EntryContentError(ValueError):
+    """Incorrect values in entries"""
+
+    def __init__(self, field, exception_type=""):
+        self.field = field  # Field index
+        self.exception_type = exception_type
+
+
+class ItemNotFoundError(Exception):
+    pass