Is there some easy way to refactor deeply coupled python code

Question

I recently took on a long ago python project which has some weird code style that I can't pinpoint. e.g.

# this is a params and value package?
opts={
infile="xxx",
outfile="xxx"
}
def parses():
    with open(opts['infile'], 'r') as f:
         #do something here and get a parased_object
         opts['infile2']=parased_object
    return
def fun1(): 
    # do someting here
    opts['fun1']=fun1_object
    return
def fun_xx():
    input_for_funcxx=opts['xx']
    #do someting here
    opts['fun_xx']=fun1_object
    return
parses()
fun1()
fun_xx()

I'm a noob who just took over such a large python project, and it's not clear to me if such a way of programming is acceptable, do I need to ask my boss to refactor it? Is there some easy way to make it clear?

Doc Brown · Accepted Answer · 2022-12-21T13:46:43.530

Well, opts serves obviously as a wrapper for global variables, and the code seems to be written in procedural style, all input and output of each function passed through global variables.

Refactoring here should go as in any other programming language when encountering such style:

First (most important): don't refactor anything for which there is no real necessity to change. When the code is running well, and you don't have a requirement to add something, leave it that way. Only focus on parts of the code base where you have to fix bugs, need to add new features, or need to optimize.
Second: make sure you have enough automated tests for the program. You will definitely break something, so better invest some time into writing regressions tests. These don't need to be unit tests, but your tests should have some reproducible input and some recorded, validated output which is known to be "correct", for a representative sets of use cases. For a non-typesafe language like Python this is even more important since there is no compiler preventing you from typos introduced by refactorings.
And for the refactoring itself: as a start, get rid of as many global variables as possible. Instead, introduce explicit input parameters and return values for each functions, and restrict their usage to the smallest possible scope possible. Functions with no side effects (or at least less side effects), and functions which don't rely on side effects are way easier to reason about and to maintain as functions which do cause or rely on side effects.

Note this can be only a start. You will probably have to apply lots of more of the standard refactoring techniques you find in books like Fowler's "Refactoring" book and Feathers' "Working Effectively with Legacy Code" book. Also have a look into one of our old, but timeless questions on this site: I've inherited 200K lines of spaghetti code -- what now?.

Good luck!

TLDR; No, there is no easy way. But there are standard approaches, which require hard work, as ever.

score 0 · Answer 2 · answered Dec 21 '22 at 06:38

Looks normal to me in Python. Big function split up into three. Zero comments, also normal for Python. Can’t quite see where to see deeply coupled code.

If things are not clear to you then don’t refactor anything until things are clear. Go to a more experienced programmer, which may be your boss, and ask them. Tell them that you would like to refactor and how.

Is there some easy way to refactor deeply coupled python code

2 Answers2