mirror of https://github.com/astral-sh/ruff
392 lines
8.1 KiB
Python
392 lines
8.1 KiB
Python
# DOC102
|
|
def add_numbers(b):
|
|
"""
|
|
Adds two numbers and returns the result.
|
|
|
|
Parameters
|
|
----------
|
|
a : int
|
|
The first number to add.
|
|
b : int
|
|
The second number to add.
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
The sum of the two numbers.
|
|
"""
|
|
return a + b
|
|
|
|
|
|
# DOC102
|
|
def multiply_list_elements(lst):
|
|
"""
|
|
Multiplies each element in a list by a given multiplier.
|
|
|
|
Parameters
|
|
----------
|
|
lst : list of int
|
|
A list of integers.
|
|
multiplier : int
|
|
The multiplier for each element in the list.
|
|
|
|
Returns
|
|
-------
|
|
list of int
|
|
A new list with each element multiplied.
|
|
"""
|
|
return [x * multiplier for x in lst]
|
|
|
|
|
|
# DOC102
|
|
def find_max_value():
|
|
"""
|
|
Finds the maximum value in a list of numbers.
|
|
|
|
Parameters
|
|
----------
|
|
numbers : list of int
|
|
A list of integers to search through.
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
The maximum value found in the list.
|
|
"""
|
|
return max(numbers)
|
|
|
|
|
|
# DOC102
|
|
def create_user_profile(location="here"):
|
|
"""
|
|
Creates a user profile with basic information.
|
|
|
|
Parameters
|
|
----------
|
|
name : str
|
|
The name of the user.
|
|
age : int
|
|
The age of the user.
|
|
email : str
|
|
The user's email address.
|
|
location : str, optional
|
|
The location of the user, by default "here".
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
A dictionary containing the user's profile.
|
|
"""
|
|
return {
|
|
'name': name,
|
|
'age': age,
|
|
'email': email,
|
|
'location': location
|
|
}
|
|
|
|
|
|
# DOC102
|
|
def calculate_total_price(item_prices, discount):
|
|
"""
|
|
Calculates the total price after applying tax and a discount.
|
|
|
|
Parameters
|
|
----------
|
|
item_prices : list of float
|
|
A list of prices for each item.
|
|
tax_rate : float
|
|
The tax rate to apply.
|
|
discount : float
|
|
The discount to subtract from the total.
|
|
|
|
Returns
|
|
-------
|
|
float
|
|
The final total price after tax and discount.
|
|
"""
|
|
total = sum(item_prices)
|
|
total_with_tax = total + (total * tax_rate)
|
|
final_total = total_with_tax - discount
|
|
return final_total
|
|
|
|
|
|
# DOC102
|
|
def send_email(subject, body, bcc_address=None):
|
|
"""
|
|
Sends an email to the specified recipients.
|
|
|
|
Parameters
|
|
----------
|
|
subject : str
|
|
The subject of the email.
|
|
body : str
|
|
The content of the email.
|
|
to_address : str
|
|
The recipient's email address.
|
|
cc_address : str, optional
|
|
The email address for CC, by default None.
|
|
bcc_address : str, optional
|
|
The email address for BCC, by default None.
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
True if the email was sent successfully, False otherwise.
|
|
"""
|
|
return True
|
|
|
|
|
|
# DOC102
|
|
def concatenate_strings(*args):
|
|
"""
|
|
Concatenates multiple strings with a specified separator.
|
|
|
|
Parameters
|
|
----------
|
|
separator : str
|
|
The separator to use between strings.
|
|
*args : str
|
|
Variable length argument list of strings to concatenate.
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
A single concatenated string.
|
|
"""
|
|
return True
|
|
|
|
|
|
# DOC102
|
|
def process_order(order_id):
|
|
"""
|
|
Processes an order with a list of items and optional order details.
|
|
|
|
Parameters
|
|
----------
|
|
order_id : int
|
|
The unique identifier for the order.
|
|
*items : str
|
|
Variable length argument list of items in the order.
|
|
**details : dict
|
|
Additional details such as shipping method and address.
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
A dictionary containing the order summary.
|
|
"""
|
|
return {
|
|
'order_id': order_id,
|
|
'items': items,
|
|
'details': details
|
|
}
|
|
|
|
|
|
class Calculator:
|
|
"""
|
|
A simple calculator class that can perform basic arithmetic operations.
|
|
"""
|
|
|
|
# DOC102
|
|
def __init__(self):
|
|
"""
|
|
Initializes the calculator with an initial value.
|
|
|
|
Parameters
|
|
----------
|
|
value : int, optional
|
|
The initial value of the calculator, by default 0.
|
|
"""
|
|
self.value = value
|
|
|
|
# DOC102
|
|
def add(self, number2):
|
|
"""
|
|
Adds two numbers to the current value.
|
|
|
|
Parameters
|
|
----------
|
|
number : int or float
|
|
The first number to add.
|
|
number2 : int or float
|
|
The second number to add.
|
|
|
|
Returns
|
|
-------
|
|
int or float
|
|
The updated value after addition.
|
|
"""
|
|
self.value += number + number2
|
|
return self.value
|
|
|
|
# DOC102
|
|
@classmethod
|
|
def from_string(cls):
|
|
"""
|
|
Creates a Calculator instance from a string representation of a number.
|
|
|
|
Parameters
|
|
----------
|
|
value_str : str
|
|
The string representing the initial value.
|
|
|
|
Returns
|
|
-------
|
|
Calculator
|
|
A new instance of Calculator initialized with the value from the string.
|
|
"""
|
|
value = float(value_str)
|
|
return cls(value)
|
|
|
|
# DOC102
|
|
@staticmethod
|
|
def is_valid_number():
|
|
"""
|
|
Checks if a given number is valid (int or float).
|
|
|
|
Parameters
|
|
----------
|
|
number : any
|
|
The value to check.
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
True if the number is valid, False otherwise.
|
|
"""
|
|
return isinstance(number, (int, float))
|
|
|
|
# OK
|
|
def function_with_kwargs(param1, param2, **kwargs):
|
|
"""Function with **kwargs parameter.
|
|
|
|
Parameters
|
|
----------
|
|
param1 : int
|
|
The first parameter.
|
|
param2 : str
|
|
The second parameter.
|
|
extra_param : str
|
|
An extra parameter that may be passed via **kwargs.
|
|
another_extra : int
|
|
Another extra parameter.
|
|
"""
|
|
return True
|
|
|
|
# OK
|
|
def add_numbers(b):
|
|
"""
|
|
Adds two numbers and returns the result.
|
|
|
|
Parameters
|
|
----------
|
|
b
|
|
The second number to add.
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
The sum of the two numbers.
|
|
"""
|
|
return a + b
|
|
|
|
# DOC102
|
|
def add_numbers(b):
|
|
"""
|
|
Adds two numbers and returns the result.
|
|
|
|
Parameters
|
|
----------
|
|
a
|
|
The first number to add.
|
|
b
|
|
The second number to add.
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
The sum of the two numbers.
|
|
"""
|
|
return a + b
|
|
|
|
class Foo:
|
|
# OK
|
|
def send_help(self, *args: Any) -> Any:
|
|
"""|coro|
|
|
|
|
Shows the help command for the specified entity if given.
|
|
The entity can be a command or a cog.
|
|
|
|
If no entity is given, then it'll show help for the
|
|
entire bot.
|
|
|
|
If the entity is a string, then it looks up whether it's a
|
|
:class:`Cog` or a :class:`Command`.
|
|
|
|
.. note::
|
|
|
|
Due to the way this function works, instead of returning
|
|
something similar to :meth:`~.commands.HelpCommand.command_not_found`
|
|
this returns :class:`None` on bad input or no help command.
|
|
|
|
Parameters
|
|
----------
|
|
entity: Optional[Union[:class:`Command`, :class:`Cog`, :class:`str`]]
|
|
The entity to show help for.
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
The result of the help command, if any.
|
|
"""
|
|
return
|
|
|
|
# OK
|
|
@classmethod
|
|
async def convert(cls, ctx: Context, argument: str) -> Self:
|
|
"""|coro|
|
|
|
|
The method that actually converters an argument to the flag mapping.
|
|
|
|
Parameters
|
|
----------
|
|
cls: Type[:class:`FlagConverter`]
|
|
The flag converter class.
|
|
ctx: :class:`Context`
|
|
The invocation context.
|
|
argument: :class:`str`
|
|
The argument to convert from.
|
|
|
|
Raises
|
|
------
|
|
FlagError
|
|
A flag related parsing error.
|
|
CommandError
|
|
A command related error.
|
|
|
|
Returns
|
|
-------
|
|
:class:`FlagConverter`
|
|
The flag converter instance with all flags parsed.
|
|
"""
|
|
return
|
|
|
|
# OK
|
|
def baz(x: int) -> int:
|
|
"""
|
|
Show a `Warnings` DOC102 false positive.
|
|
|
|
Parameters
|
|
----------
|
|
x : int
|
|
|
|
Warnings
|
|
--------
|
|
This function demonstrates a DOC102 false positive
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
"""
|
|
return x
|