Ахлотро тоза кунед

TL; DR: Функсияҳои истифоданашуда, константаҳо ва рамзи "танҳо дар ҳолати" -ро нест кунед.

Мушкилотҳои ҳалшуда

• Кодекси мурда
• Рамзи танҳо дар ҳолати
• Нигоҳдории паст
• Киштиҳои лангар
• Сарбории маърифатӣ

Бӯи рамзи марбут

Қадамҳо

1. Боварӣ ҳосил кунед, ки рамзи шумо фарогирии хуби функсионалӣ дорад.
2. Функсияҳо ва константаҳои истифоданашударо тавассути баррасии коди худ ё бо истифода аз абзорҳои таҳлили статикӣ муайян кунед.
3. Рамзи спекулятивии иловашударо дар ҳар сурат таҳлил кунед.
4. Ҳама чизи нолозим ё истифоданашударо хориҷ кунед.
5. Дар коди худ санҷиши ҳамаҷонибаи регрессияро иҷро кунед.

Рамзи намунавӣ

Пеш аз

 from flask import Flask, jsonify, make_response app = Flask(__name__) HTTP_100_CONTINUE = 100 HTTP_202_ACCEPTED = 202 # Not used HTTP_204_NO_CONTENT = 204 # Not Used HTTP_302_FOUND = 302 # Not Used HTTP_400_BAD_REQUEST = 400 # Not Used HTTP_401_UNAUTHORIZED = 401 # Not Used HTTP_403_FORBIDDEN = 403 HTTP_404_NOT_FOUND = 404 HTTP_410_GONE = 410 HTTP_500_INTERNAL_SERVER_ERROR = 500 HTTP_501_NOT_IMPLEMENTED = 501 probe_telemetry = { "temperature": {"solar_panels": 150, "instrument_1": 50}, "position": {"x": 1000000, "y": 2000000, "z": 3000000, "velocity": {"vx": 100, "vy": 200, "vz": 300}}, "status": {"power_level": 95, "communication_status": "OK"} } @app.route('/api/v1/probe/telemetry', methods=['GET']) def get_telemetry(): return jsonify(probe_telemetry), HTTP_200_OK # The following function is not invoked # and not implemented # It is a dead placeholder @app.route('/api/v1/probe/send_command', methods=['POST']) def send_command(): return jsonify( {"message": "Command endpoint not implemented yet."} ), HTTP_501_NOT_IMPLEMENTED @app.route('/api/v1/probe/data', methods=['GET']) def get_data(): return jsonify({"message": "Data not found"}), HTTP_404_NOT_FOUND @app.route('/api/v1/probe/redirect', methods=['GET']) def redirect_endpoint(): response = make_response( jsonify({"message": "Redirecting..."}), HTTP_301_MOVED_PERMANENTLY ) response.headers['Location'] = '/api/v1/probe/telemetry' return response @app.route('/api/v1/probe/not_modified', methods=['GET']) def not_modified_endpoint(): response = make_response(jsonify({"message": "Not Modified"}), HTTP_304_NOT_MODIFIED) response.headers['ETag'] = 'some_etag' return response @app.route('/api/v1/probe/gone', methods=['GET']) def gone_endpoint(): return jsonify( {"message": "Resource permanently gone"} ), HTTP_410_GONE

Баъди

 # 1. Ensure your code has good functional coverage. from flask import Flask, jsonify, make_response from http import HTTPStatus app = Flask(__name__) # 2. Identify unused functions and constants # by reviewing your code or using static analysis tools. HTTP_200_OK = HTTPStatus.OK HTTP_301_MOVED_PERMANENTLY = HTTPStatus.MOVED_PERMANENTLY HTTP_304_NOT_MODIFIED = HTTPStatus.NOT_MODIFIED HTTP_404_NOT_FOUND = HTTPStatus.NOT_FOUND HTTP_410_GONE = HTTPStatus.GONE HTTP_501_NOT_IMPLEMENTED = HTTPStatus.NOT_IMPLEMENTED probe_telemetry = { "temperature": {"solar_panels": 150, "instrument_1": 50}, "position": {"x": 1000000, "y": 2000000, "z": 3000000, "velocity": {"vx": 100, "vy": 200, "vz": 300}}, "status": {"power_level": 95, "communication_status": "OK"} } @app.route('/api/v1/probe/telemetry', methods=['GET']) def get_telemetry(): return jsonify(probe_telemetry), HTTP_200_OK # 3. Analyze the added speculative code, just in case. @app.route('/api/v1/probe/send_command', methods=['POST']) def send_command(): return jsonify({"message": "Command endpoint not implemented yet."}), HTTP_501_NOT_IMPLEMENTED @app.route('/api/v1/probe/data', methods=['GET']) def get_data(): return jsonify({"message": "Data not found"}), HTTP_404_NOT_FOUND # 4. Remove anything unnecessary or unused. # 5. Perform comprehensive regression testing on your code.

Навъи

• [x] Нимавтомати

Шумо метавонед қадамҳои кӯдакро иҷро кунед ва рамзи нолозимро дар такрорҳо хориҷ кунед.

Бехатарӣ

Ин рефакторинг бехатар аст, агар шумо аризаи худро пас аз тағирот ҳамаҷониба санҷед. Воситаҳои таҳлили статикӣ метавонанд ба шумо кӯмак расонанд, ки шумо чизеро, ки ҳоло истифода мешавад, нест накунед.

Чаро Кодекс беҳтар аст?

Шумо тавассути нест кардани унсурҳои истифоданашуда возеҳиро беҳтар мекунед ва мураккабиро кам мекунед.

Рамзи шумо фаҳмидан ва нигоҳдорӣ осонтар мешавад.

Кам кардани рамзи тахминӣ инчунин диққати шуморо ба талаботи ҷорӣ ва воқеӣ нигоҳ медорад.

Чӣ тавр он Бижекцияро беҳтар мекунад?

Рамзи мурда ва унсурҳои тахминӣ Bijection-ро байни нармафзори шумо ва модели воқеии ҷаҳон вайрон мекунанд.

Хориҷ кардани ин унсурҳо кафолат медиҳад, ки рамзи шумо MAPPER -и шуморо дақиқ муаррифӣ мекунад ва онро тозатар ва ба воқеият наздиктар мекунад.

Маҳдудиятҳо

Бартараф кардани рамзи мурда эътимодро талаб мекунад, ки он воқеан истифоданашуда аст.

Ин раванд ба таҳлили статикӣ ё дониши ҳамаҷонибаи кодҳо такя мекунад, ки бе асбобҳои мустаҳкам метавонад ба хатогиҳо дучор шавад.

Refactor бо AI

Тегҳо

• Блотерҳо

Рефакторингҳои марбут

Қарзҳо

Тасвир аз ҷониби Питер Ҳ аз Pixabay

Ин мақола як қисми Силсилаи Refactoring аст.