Guide to High School Computer Science
  • 💻Introduction
    • windows & Python Development
    • macOS & Python Development
    • Visual Studio Code Settings
    • Set up Github
    • Author Page
  • 🧠Prerequisite Skills
    • Keyboard Typing
    • Files & Directories
    • Use of Command Line
    • Git & GitHub
    • Markdown
    • Starting Your Python Project
  • 🐍Python Programming
    • 🍎Python Basics
      • What is Python?
      • Procedural Programming & Programming Paradigms
      • String Formatting
      • Data Types
      • Input & Output to Console
      • Working with Numbers
      • Useful Built-in Functions
      • Math & Random Module
      • Boolean Data Object
      • Comparison, Logical, and Membership Operators
      • If Statements
      • Binary Decisions
      • Multiple Decisions
      • Nested Conditions
      • [EXTRA] Bitwise Operators
      • [EXTRA] Python Style Guide
    • ⏮️Iterations
      • Introduction to While Loops
      • Infinite Loop
      • Controlling Your While Loops
      • Introduction to For Loops
      • For Loops w/ Numeric Sequences
      • For Loops w/ Strings & Lists
      • Iterable Functions w/ For Loops
    • 📦Collections
      • Strings
        • String Basics
        • String Indexing
        • String Slicing
        • String Operators & Functions
        • Basic String Methods
        • String Methods Extended
        • String Methods Document
      • Tuples & Lists
        • Tuples
        • List Basics
        • List are Mutable
        • Adding Items to a List
        • Removing Items from a List
        • Search & Reverse a List
        • List Comprehension
        • List Methods Document
      • Sets
      • Dictionary
      • How to Store Multiple Data Items
    • 💡Defining Functions
      • Functions
      • print() vs return
      • Pre-determined Arguments
      • Nested Functions
      • Map & Filter
      • [Extra] Dynamic Arguments
    • 💾File I/O
      • How to Save Text to an External File
      • Reading CSV in Python
      • Reading JSON in Python
    • 🔨Basic Python Projects
      • Basic Calculator
        • Improving the calculator
        • Exercise Set 1
        • Exercise Set 2
        • 💎Streamlit Application #1
      • Basic Password Generator
        • Exercise Set 3
        • Exercises Related to Math
        • 💎Streamlit Application #2
      • A To-Do Task List
    • ⏳Introduction to Algorithmic Thinking
      • Big-O Notation
      • Basic Algorithms
        • Linear Search
        • Binary Search
        • Basic Sorting Algorithms
      • Recursion
      • Brute Force Algorithms
      • Greedy Algorithm
        • Time on Task (CCC 2013 J4)
        • Dijkstra’s Algorithm
      • Divide and Conquer
        • Merge Sort
      • Dynamic Programming
    • 🤯Object Oriented Programming
      • Class & Objects (Definitions)
      • OOP in Python
      • Encapsulation
      • Polymorphism
      • Inheritance & Overriding
      • Override Magic Methods
      • Case Study: 2D Vectors
      • Case Study: Deck of Cards
      • Exercise
      • Abstract Data Types
      • Case Study: Static 1D Array From Java
    • Competitive Programming
      • Is This Sum Possible?
        • Is the dataset sorted?
        • Searching for a value
        • Determine if the difference between an integer from the array and the target value exists
        • Sorting Algorithms
        • Using Two Pointers
      • Two Sum - LeetCode
        • Generate all possible pairs of values
        • Subtract each value from the target, see if the difference exists in the list
      • Longest Common Prefix - LeetCode
        • Compare all possible prefixes
        • Create the longest common prefix with the direct neighbour
      • Length of Last Word - LeetCode
        • Compare all possible prefixes
      • Where can I go from one point to another?
      • Sample Outline
    • IB Recipe Book
  • 💾Python & Databases
    • Intro to Databases & Data Modeling
      • Common Data Types in SQL
      • Introduction to ERDs
      • Primary Keys and Foreign Keys
      • Database Normalization
    • What is SQL?
      • Getting Started
      • SELECT Queries
        • Selection with Conditions
        • Selection with Fuzziness
        • Selection and Sorting in Order
        • Selection without Duplicates
        • Selection with Limited Number of Outputs
      • AGGREGATE Queries
        • Counting Rows
        • Sum, Average, Min/Max Queries
        • Working with Aggregate Queries
        • Power of using Groups
        • Exercise
      • Interacting with Multiple Table
      • Inserting Data
      • External Resource
  • ☕Java Essentials
    • Basics
      • Starting Java
      • Data & Variables
      • Handling User Inputs & Type Conversion
      • Arithmetic
      • IPO Model
      • Basic Built-in Methods
      • Exercise Questions
    • Conditionals
      • Boolean Operators
      • Compare Strings
      • If Statements
      • If Else Statements
      • Making Multiple Decisions
      • Using Switch
      • Flowchart Symbols
      • Exercise Questions
    • Iterations
      • While Loops
      • For Loop
      • Exercises
    • Java Type Casting
    • Strings
      • Common String Practices
      • String Formatting
      • Java Special Characters
    • Collection
      • Arrays
      • For Each Loop
      • ArrayList
      • Exercise Questions
    • Static Methods
      • (Aside) Clearing your Console
    • Randomness in Java
    • Delayed Output in Java
    • Java Output Formatting
    • Java Style Guide
  • 🛠️JavaScript Programming
    • Our Programming Editor & Workflow
      • Hello, world!
      • Commenting & Variables
      • Data in JavaScript
      • Operators
      • String Formatting
      • Getting User Input
    • JavaScript Exercise Set 1
    • Making Decisions
      • Comparing Values
      • Combining Boolean Comparisons
      • Creating Branches
    • JavaScript Exercise Set 2
    • While Loops
      • Infinite While Loop
      • While Loops and Numbers
      • While Loops and Flags
      • While loops w/ Strings
    • JavaScript Exercise Set 3
    • Subprograms & Functions
      • Creating a Function in JavaScript
      • Function with Input and Assignable Output
    • JavaScript Exercise Set 4
  • 💾Topics in CS
    • Computer Environments & Systems
      • Computer Components
        • In-depth Explanations
      • File Maintenance
      • Computer & Safety
      • Software Development
      • Bits & Binary
    • Careers related to Computer Science
    • Postsecondary Opportunities
Powered by GitBook
On this page
  • What is a Function?
  • Mindset for writing Functions in Python
  • Python Function Syntax
  • Explanation
  1. Python Programming
  2. Defining Functions

Functions

PreviousDefining FunctionsNextprint() vs return

Last updated 8 months ago

  • In Python 3, we are able to create custom functions that are much similar to the built-in functions we have encountered

  • These functions are callable and can output results to our liking

  • This allows us to organize our code when our projects become more complex

  • In this unit we will only cover introductory level content for functions (returning values, predetermined arguments, and nested functions).

What is a Function?

Function: a block of organized, reusable code that is usually used to perform single and related action.

Similar concepts: methods, subroutines and procedures

Mathematical Functions vs Programming Functions

Mathematical Function: Functions we learn in math classes, such as Grade 11 Functions, are by in nature following the laws of mathematics. These functions (Quadratic, Rational, Trignometric and Logarithmic to name a few) are all about relating an input to an output. They also must follow the these rules:

  1. One input must have only one output

  2. Multiple inputs are allowed to have same output

Programming Function: In computer science, a function is a self contained module of code. It is not restricted to the rules of mathematical function unless you want it do be.

Mindset for writing Functions in Python

  1. Clean Code: We want organize a solution to problem or a part of a problem into a single function

  2. Algorithms: Without functions, we cannot express algorithms properly

  3. Reusability: Functions prevent us from repeating code you’ve written before

  4. Single Serving: Functions prevent overloaded programs that look like spaghetti

Python Function Syntax

def functionName(arg1, arg2, arg3):
    # docStrings for a function is created with triple-quotation marks
    ''' short + sweet single line explanation of what the function does
    
    Args:
        arg1: description, mention datatype
        arg2: description, mention datatype
        arg3: description, mention datatype
    
    Returns:
        the datatype of the returned object, describe what it represents too
    '''

    # write code inside the function here

    return value
# end of functionName()

How to use docstrings

  1. Write a short single sentence on what the function does

  2. List each arguments and describe what they are and the datatype

  3. Describe the return statements data type and what it returned.

Function Rules:

  • def is the keyword designated to help us define a custom function

  • (arg1, arg2, arg3): This is state our function inputs. The number of inputs a function require is up to you. A proper definition for function inputs are called arguments.

  • We can also write a descriptor for our function by using triple single(') or double(") quotation marks

  • return is a keyword designed for functions. When a function is done executing its code, we can use return to help us grab the result of our function

Let’s create an example function for the area of a circle.

def areaCircle(radius, pi=3.14):
    ''' calculates the area of a circle

    arguments:
        radius : represents the radius value of a circle, floating point value
        pi : takes in a pi value, assumed to be 3.14 if not provided, floating point value

    return:
        an integer describing the caluculated area
    '''

    area = pi * (radius ** 2)

    return area
# end of areaCircle

my_radius = 6
pi = 3.14159

my_circle_area = areaCircle(my_radius, pi)
my_circle_area2 = areaCircle(my_radius, 3.14)

print(f'The area of my circle is {my_circle_area} units squared.')
print(f'The area of my circle with pi of 3.14 is {my_circle_area2} units squared.')
The area of my circle is 113.0972 units squared.
The area of my circle with pi of 3.14 is 113.0400 units squared.

Explanation

  1. We defined a function called areaCircle

  2. There are 2 arguments

    • radius

    • pi

  3. There is a docstring trapped inside triple single quotation marks

  4. Variable area inside the function is calculated by using the argument variables for the function

  5. We use the return keyword to help us grab the resulting variable called: area

  6. After the function has been defined we created our new variables of my_radius and pi

    • please note that the new variable pi = 3.14159 does not conflict with the function’s argument variable

    • We can use these new variables to be the explicit arguments for when we call the function

  7. We calculated the result for two variables: my_circle_area and my_circle_area2 by assigning it to the result of us calling our defined function

    • When the function areaCircle is called, it will take the given arguments to calculate the function’s area variable

    • Once the calculation is finished, it will be returned back to the variable and assigned with the result

A docstring should give enough information to write a call to the function without reading the function’s code. The docstring should describe the function’s calling syntax and its semantics, but generally not its implementation details, unless those details are relevant to how the function is to be used. ()

a function must have a callable name … it is recommended to use name that is not or for Python.

🐍
💡
Source
built-in function
keywords