Takarítsd ki a szemetet

TL;DR: Távolítsa el a nem használt függvényeket, konstansokat és „csak az esetre” kódot.

Problémák megoldva

• Halott kód
• Minden esetre kód
• Csökkentett karbantarthatóság
• Horgonyhajók
• Kognitív terhelés

Kapcsolódó kódszagok

Lépések

1. Győződjön meg arról, hogy a kód megfelelő funkcionális lefedettséggel rendelkezik.
2. Azonosítsa a nem használt függvényeket és konstansokat a kód áttekintésével vagy statikus elemző eszközök használatával.
3. Elemezze a hozzáadott spekulatív kódot, minden esetre.
4. Távolítson el mindent, ami felesleges vagy nem használt.
5. Végezzen átfogó regressziós tesztet a kódon.

Minta kód

Előtt

 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

Után

 # 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.

Írja be

• [x] Félautomata

Az iterációk során babalépéseket hajthat végre, és eltávolíthatja a felesleges kódot.

Biztonság

Ez az átalakítás biztonságos, ha a változtatások után alaposan teszteli az alkalmazást. A statikus elemző eszközök segíthetnek abban, hogy ne távolítson el semmit, ami még használatban van.

Miért jobb a kód?

A nem használt elemek eltávolításával javítja az áttekinthetőséget és csökkenti a bonyolultságot.

A kód könnyebben érthető és karbantartható.

A spekulatív kódok csökkentése az aktuális, tényleges követelményekre is összpontosít.

Hogyan javítja az elhajlást?

A holt kód és a spekulatív elemek megtörik a szoftver és a valós modell közötti bijekciót .

Ezeknek az elemeknek az eltávolítása biztosítja, hogy a kód pontosan reprezentálja a MAPPER- t, így tisztább és közelebb kerül a valósághoz.

Korlátozások

A halott kód eltávolításához meg kell bizonyosodni arról, hogy valóban nem használt.

Ez a folyamat statikus elemzésen vagy alapos kódbázis-ismereten alapul, amely robusztus eszközök nélkül is hibás lehet.

Refaktor AI-val

Címkék

• Puffadók

Kapcsolódó refaktorálások

Kredit

Kép: Peter H a Pixabay- től

Ez a cikk a Refaktoring Series része.