Preflight checks hackathon 2024

[jmcouffin]

Hi guys,
@dosymep @sanzoghenzo @eirannejad @GiuseppeDotto @thumDer
@dnenov @davidvadkerti @dariaivanciucova
Would you give care to give me your evaluation of the work done by the few preflight checks hackathon participants?
It should not take you long, I hope to collect your input to provide the results by next monday.

• cad_audit
• walltypes_naming_convention
• and radar_check

set the order and add comments following my template to evaluate:

1. radar_check
   I like the idea, it is pretty elaborate
2. cad_audit
   fair entry, coding style is a bit weak
3. walltypes
   the idea is good, it lack a bit of love, and could be extended to lots of naming_convention checks on the same principes adding a UI/UX to configure the check

[sanzoghenzo]

I'm not qualified to judge this since I never used the model checker and I don't use Revit/pyRevit - i just develop code for my colleagues!

I just can give an opinion on the code itself

1. radar check: it needs a lot of love! in order of importance
   • the doc global variable is used inside the function that have the document argument; while not a problem in this specific case, it results in functions that are not portable;
   • one of the function returns a constant (INTERNAL_ORIGIN) that is then rewritten to itself; this is unneeded cognitive load.
   • there's a class with a single method that never accesses self, so it should be a function!
   • some functions are too long and returns many variables; it is more or less trivial to split them into smaller, simpler functions
   • some functions are called twice or more with the same parameters, the result should be stored in a variable and reused
   • other un-pythonic things here and there, formatting needs some fixes
2. cad audit: medium complexity, medium code quality 😅
   • collect_cadinstances gets called two times, the second time just to get the length of the list... wasted CPU cycles here
   • the timer is initialized above the function that needs to be timed, but this means that it is started when the file is loaded and not when the function is actually called! I would put it either inside of the function or move the timing inside the startTest method
   • there's a bunch of appends one after another, it is better to just create the list with the elements in it at once
   • (not sure on this one, but couldn't the two static methods of ButtonClass just be functions?)
   • there are a bit of repeated code, that can also use more calls to the pyrevit library
   • other un-pythonic things here and there
3. walltypes: the simplest and cleanest one, but there are still some design choices I would have avoided:
   • uses a json file just for a list of strings, it might be just a plain text file
   • lists are used where generators or sets would be better choices (less memory usage and faster membership checks)
   • hardcoded path that couls pose a problem for clones not in the default location
   • the found key is not used, it wastes memory
   • the value of the wrong key could be computed with a difference between sets and stored in a variable by its own for easier access

PS: I realize just now that the notion page example has unneeded lines (all the methods that have only a pass statement should be removed) that propagated to all the contestant's code 😅

[thumDer]

Hi Jean-Marc! I'm still on holiday this week but next week I can also take a look at them on monday, or tuesday the latest. Sent from Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: Andrea Ghensi ***@***.***> Sent: Tuesday, November 5, 2024 9:21:53 PM To: pyrevitlabs/pyRevit ***@***.***> Cc: Tamás Déri ***@***.***>; Mention ***@***.***> Subject: Re: [pyrevitlabs/pyRevit] Preflight checks hackathon 2024 (PR #2454) I'm not qualified to judge this since I never used the model checker and I don't use Revit/pyRevit - i just develop code for my colleagues! I just can give an opinion on the code itself 1. radar check: it needs a lot of love! in order of importance * the doc global variable is used inside the function that have the document argument; while not a problem in this specific case, it results in functions that are not portable; * one of the function returns a constant (INTERNAL_ORIGIN) that is then rewritten to itself; this is unneeded cognitive load. * there's a class with a single method that never accesses self, so it should be a function! * some functions are too long and returns many variables; it is more or less trivial to split them into smaller, simpler functions * some functions are called twice or more with the same parameters, the result should be stored in a variable and reused * other un-pythonic things here and there, formatting needs some fixes 2. cad audit: medium complexity, medium code quality 😅 * collect_cadinstances gets called two times, the second time just to get the length of the list... wasted CPU cycles here * the timer is initialized above the function that needs to be timed, but this means that it is started when the file is loaded and not when the function is actually called! I would put it either inside of the function or move the timing inside the startTest method * there's a bunch of appends one after another, it is better to just create the list with the elements in it at once * (not sure on this one, but couldn't the two static methods of ButtonClass just be functions?) * there are a bit of repeated code, that can also use more calls to the pyrevit library * other un-pythonic things here and there 3. walltypes: the simplest and cleanest one, but there are still some design choices I would have avoided: * uses a json file just for a list of strings, it might be just a plain text file * lists are used where generators or sets would be better choices (less memory usage and faster membership checks) * hardcoded path that couls pose a problem for clones not in the default location * the found key is not used, it wastes memory * the value of the wrong key could be computed with a difference between sets and stored in a variable by its own for easier access PS: I realize just now that the notion page example has unneeded lines (all the methods that have only a pass statement should be removed) that propagated to all the contestant's code 😅 — Reply to this email directly, view it on GitHub<#2454 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ANAHQJEM3ONASHCJQPCKX43Z7EZHDAVCNFSM6AAAAABRFEISKCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJYGE3TGOBVHE>. You are receiving this because you were mentioned.Message ID: ***@***.***>