What's a convenience function?





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}







1















In the timeit module there is the code below - what's a convenience function? I googled it and couldn't find a good answer:



def timeit(stmt="pass", setup="pass", timer=default_timer,
number=default_number, globals=None):
"""Convenience function to create Timer object and call timeit method."""
return Timer(stmt, setup, timer, globals).timeit(number)









share|improve this question


















  • 7





    A function defined for convenience.

    – juanpa.arrivillaga
    Nov 17 '18 at 1:00






  • 1





    @juanpa.arrivillaga: don't be so dismissive, there's more to it. As GreenCloakGuy's answer mentions, they help prevent litter your namespace with throwaway objects and temporaries. Which is especially important given Python's slightly non-standard scoping rules.

    – smci
    Nov 17 '18 at 1:27




















1















In the timeit module there is the code below - what's a convenience function? I googled it and couldn't find a good answer:



def timeit(stmt="pass", setup="pass", timer=default_timer,
number=default_number, globals=None):
"""Convenience function to create Timer object and call timeit method."""
return Timer(stmt, setup, timer, globals).timeit(number)









share|improve this question


















  • 7





    A function defined for convenience.

    – juanpa.arrivillaga
    Nov 17 '18 at 1:00






  • 1





    @juanpa.arrivillaga: don't be so dismissive, there's more to it. As GreenCloakGuy's answer mentions, they help prevent litter your namespace with throwaway objects and temporaries. Which is especially important given Python's slightly non-standard scoping rules.

    – smci
    Nov 17 '18 at 1:27
















1












1








1








In the timeit module there is the code below - what's a convenience function? I googled it and couldn't find a good answer:



def timeit(stmt="pass", setup="pass", timer=default_timer,
number=default_number, globals=None):
"""Convenience function to create Timer object and call timeit method."""
return Timer(stmt, setup, timer, globals).timeit(number)









share|improve this question














In the timeit module there is the code below - what's a convenience function? I googled it and couldn't find a good answer:



def timeit(stmt="pass", setup="pass", timer=default_timer,
number=default_number, globals=None):
"""Convenience function to create Timer object and call timeit method."""
return Timer(stmt, setup, timer, globals).timeit(number)






python python-3.x






share|improve this question













share|improve this question











share|improve this question




share|improve this question










asked Nov 17 '18 at 0:59









user3124200user3124200

804




804








  • 7





    A function defined for convenience.

    – juanpa.arrivillaga
    Nov 17 '18 at 1:00






  • 1





    @juanpa.arrivillaga: don't be so dismissive, there's more to it. As GreenCloakGuy's answer mentions, they help prevent litter your namespace with throwaway objects and temporaries. Which is especially important given Python's slightly non-standard scoping rules.

    – smci
    Nov 17 '18 at 1:27
















  • 7





    A function defined for convenience.

    – juanpa.arrivillaga
    Nov 17 '18 at 1:00






  • 1





    @juanpa.arrivillaga: don't be so dismissive, there's more to it. As GreenCloakGuy's answer mentions, they help prevent litter your namespace with throwaway objects and temporaries. Which is especially important given Python's slightly non-standard scoping rules.

    – smci
    Nov 17 '18 at 1:27










7




7





A function defined for convenience.

– juanpa.arrivillaga
Nov 17 '18 at 1:00





A function defined for convenience.

– juanpa.arrivillaga
Nov 17 '18 at 1:00




1




1





@juanpa.arrivillaga: don't be so dismissive, there's more to it. As GreenCloakGuy's answer mentions, they help prevent litter your namespace with throwaway objects and temporaries. Which is especially important given Python's slightly non-standard scoping rules.

– smci
Nov 17 '18 at 1:27







@juanpa.arrivillaga: don't be so dismissive, there's more to it. As GreenCloakGuy's answer mentions, they help prevent litter your namespace with throwaway objects and temporaries. Which is especially important given Python's slightly non-standard scoping rules.

– smci
Nov 17 '18 at 1:27














1 Answer
1






active

oldest

votes


















3














It's a function that exists so you don't have to bother instantiating and keeping track of an object yourself. For example, in the timeit module, the only thing that can actually perform the functionality you want is the Timer object - but you as the programmer don't want to care about the lifecycle of that Timer, or bring it into your namespace. Hence, this timeit.timeit() function creates a Timer object relatively anonymously and calls timeit() on it, without you needing to keep track of that Timer object. It'll just do what you want it to and you don't have to worry about the details - convenience.



There are numerous other functions like this, that are essentially wrappers for instantiating a class and running a method - another example is subprocess.run(), which creates a Popen object that, again, the programmer doesn't have to keep track of.



See also the Wikipedia definition of a convenience function.






share|improve this answer
























    Your Answer






    StackExchange.ifUsing("editor", function () {
    StackExchange.using("externalEditor", function () {
    StackExchange.using("snippets", function () {
    StackExchange.snippets.init();
    });
    });
    }, "code-snippets");

    StackExchange.ready(function() {
    var channelOptions = {
    tags: "".split(" "),
    id: "1"
    };
    initTagRenderer("".split(" "), "".split(" "), channelOptions);

    StackExchange.using("externalEditor", function() {
    // Have to fire editor after snippets, if snippets enabled
    if (StackExchange.settings.snippets.snippetsEnabled) {
    StackExchange.using("snippets", function() {
    createEditor();
    });
    }
    else {
    createEditor();
    }
    });

    function createEditor() {
    StackExchange.prepareEditor({
    heartbeatType: 'answer',
    autoActivateHeartbeat: false,
    convertImagesToLinks: true,
    noModals: true,
    showLowRepImageUploadWarning: true,
    reputationToPostImages: 10,
    bindNavPrevention: true,
    postfix: "",
    imageUploader: {
    brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
    contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
    allowUrls: true
    },
    onDemand: true,
    discardSelector: ".discard-answer"
    ,immediatelyShowMarkdownHelp:true
    });


    }
    });














    draft saved

    draft discarded


















    StackExchange.ready(
    function () {
    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53347240%2fwhats-a-convenience-function%23new-answer', 'question_page');
    }
    );

    Post as a guest















    Required, but never shown

























    1 Answer
    1






    active

    oldest

    votes








    1 Answer
    1






    active

    oldest

    votes









    active

    oldest

    votes






    active

    oldest

    votes









    3














    It's a function that exists so you don't have to bother instantiating and keeping track of an object yourself. For example, in the timeit module, the only thing that can actually perform the functionality you want is the Timer object - but you as the programmer don't want to care about the lifecycle of that Timer, or bring it into your namespace. Hence, this timeit.timeit() function creates a Timer object relatively anonymously and calls timeit() on it, without you needing to keep track of that Timer object. It'll just do what you want it to and you don't have to worry about the details - convenience.



    There are numerous other functions like this, that are essentially wrappers for instantiating a class and running a method - another example is subprocess.run(), which creates a Popen object that, again, the programmer doesn't have to keep track of.



    See also the Wikipedia definition of a convenience function.






    share|improve this answer




























      3














      It's a function that exists so you don't have to bother instantiating and keeping track of an object yourself. For example, in the timeit module, the only thing that can actually perform the functionality you want is the Timer object - but you as the programmer don't want to care about the lifecycle of that Timer, or bring it into your namespace. Hence, this timeit.timeit() function creates a Timer object relatively anonymously and calls timeit() on it, without you needing to keep track of that Timer object. It'll just do what you want it to and you don't have to worry about the details - convenience.



      There are numerous other functions like this, that are essentially wrappers for instantiating a class and running a method - another example is subprocess.run(), which creates a Popen object that, again, the programmer doesn't have to keep track of.



      See also the Wikipedia definition of a convenience function.






      share|improve this answer


























        3












        3








        3







        It's a function that exists so you don't have to bother instantiating and keeping track of an object yourself. For example, in the timeit module, the only thing that can actually perform the functionality you want is the Timer object - but you as the programmer don't want to care about the lifecycle of that Timer, or bring it into your namespace. Hence, this timeit.timeit() function creates a Timer object relatively anonymously and calls timeit() on it, without you needing to keep track of that Timer object. It'll just do what you want it to and you don't have to worry about the details - convenience.



        There are numerous other functions like this, that are essentially wrappers for instantiating a class and running a method - another example is subprocess.run(), which creates a Popen object that, again, the programmer doesn't have to keep track of.



        See also the Wikipedia definition of a convenience function.






        share|improve this answer













        It's a function that exists so you don't have to bother instantiating and keeping track of an object yourself. For example, in the timeit module, the only thing that can actually perform the functionality you want is the Timer object - but you as the programmer don't want to care about the lifecycle of that Timer, or bring it into your namespace. Hence, this timeit.timeit() function creates a Timer object relatively anonymously and calls timeit() on it, without you needing to keep track of that Timer object. It'll just do what you want it to and you don't have to worry about the details - convenience.



        There are numerous other functions like this, that are essentially wrappers for instantiating a class and running a method - another example is subprocess.run(), which creates a Popen object that, again, the programmer doesn't have to keep track of.



        See also the Wikipedia definition of a convenience function.







        share|improve this answer












        share|improve this answer



        share|improve this answer










        answered Nov 17 '18 at 1:16









        Green Cloak GuyGreen Cloak Guy

        3,4101721




        3,4101721
































            draft saved

            draft discarded




















































            Thanks for contributing an answer to Stack Overflow!


            • Please be sure to answer the question. Provide details and share your research!

            But avoid



            • Asking for help, clarification, or responding to other answers.

            • Making statements based on opinion; back them up with references or personal experience.


            To learn more, see our tips on writing great answers.




            draft saved


            draft discarded














            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53347240%2fwhats-a-convenience-function%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown





















































            Required, but never shown














            Required, but never shown












            Required, but never shown







            Required, but never shown

































            Required, but never shown














            Required, but never shown












            Required, but never shown







            Required, but never shown







            Popular posts from this blog

            Xamarin.iOS Cant Deploy on Iphone

            Glorious Revolution

            Dulmage-Mendelsohn matrix decomposition in Python