Require Keyword Arguments

July 13th, 2014
python, tech
To avoid errors in calling a python function you might want to ensure it's only ever called with keyword arguments. Say you have:
    def score(actual, predicted):
       ...
and you're worried people accidentally call it with the arguments reversed. After all, nothing looks surprising with:
    score(model.predict(data), isRepaid)
We can have a culture where everyone writes in the keyword arguments, as:
    score(actual=isRepaid, predicted=model.predict(data))
This mostly solves the problem, but could we have Python check this for us? Yes! PEP 3102 added this to Python 3+:
    def score(*, actual, predicted):
      ..
But what about the Python 2 series? You could rebuild Python with this patch applied, or you could use a decorator that verifies there are no positional arguments and then calls the original function:
    def poscheck(f):
      def checked_f(*args, **kwargs):
        if args:
          raise PositionalArgumentsError(f)
        f(**kwargs)
      return checked_f

    @poscheck
    def score(actual, predicted):
      ...
This is pretty good, but what about a case like this:
    # Split s on newlines ('\n'), returning a list.  These newlines
    # are not normally retained, but if the optional keepends argument
    # is True then they're kept.
    def splitlines(s, keepends=False):
       ...
If someone calls splitlines as splitlines(s, True) that's going to be pretty confusing to a reader. You'd like to make sure writers always make it clear what the boolean is about, so you have a house style where you write splitlines(s, keepends=True). If you used poscheck, though, that would require splitlines(s=s, keepends=True) which is too verbose. So, use poscheck_except instead:
    @poscheck_except(1)
    def splitlines(s, keepends=False):
      ...
This will require that after the first positional argument all other arguments are given with keywords, if present.

The code is poscheck on github.

Comment via: google plus, facebook, substack

Recent posts on blogs I like:

Ozy at LessOnline!

I will once again be a guest at LessOnline, alongside many other writers whom you no doubt like less than you like me: Scott Alexander, dynomight, Georgia Ray, David Friedman, Nicholas Decker, Jacob Falkovich, Kelsey Piper, Alicorn, Aella, etc.

via Thing of Things March 23, 2026

Daycares and the Brown School

As someone in Somerville I notice that there are quite high prices regarding childcare. The average family in Somerville pays $1,100 to $3,500 for daycare per month, and I want to make the costs more affordable. I have also noticed that housing is quite …

via Lily Wise's Blog Posts March 22, 2026

2025-26 New Year review

This is an annual post reviewing the last year and setting intentions for next year. I look over different life areas (work, health, parenting, effectiveness, etc) and analyze my life tracking data. Highlights include a minimal group house, the usefulness…

via Victoria Krakovna January 19, 2026

more     (via openring)