Diferença de Datas Python | Cálculo de Meses

Introdução

Trabalhar com datas e horas é uma tarefa comum em programação. Python oferece o poderoso módulo datetime para lidar com operações de data e hora de forma eficiente. Neste laboratório, você aprenderá como calcular a diferença entre duas datas em termos de meses, o que é útil para cálculos financeiros, cronogramas de projetos e análise de dados.

Compreendendo Objetos de Data em Python

Antes de calcular a diferença de meses entre datas, precisamos entender como trabalhar com objetos de data em Python. Nesta etapa, aprenderemos sobre o módulo datetime e criaremos alguns objetos de data.

Primeiro, vamos criar um novo arquivo Python no diretório do projeto. Abra a WebIDE e clique no ícone "New File" (Novo Arquivo) no painel do explorador no lado esquerdo. Nomeie o arquivo month_difference.py e salve-o no diretório /home/labex/project.

Agora, adicione o seguinte código para importar os módulos necessários:

from datetime import date
from math import ceil

## Create example date objects
date1 = date(2023, 1, 15)  ## January 15, 2023
date2 = date(2023, 3, 20)  ## March 20, 2023

## Print the dates to see their format
print(f"Date 1: {date1}")
print(f"Date 2: {date2}")

## Calculate the difference in days
day_difference = (date2 - date1).days
print(f"Difference in days: {day_difference}")

Salve o arquivo e execute-o usando o terminal:

python3 ~/project/month_difference.py

Você deve ver uma saída semelhante a esta:

Date 1: 2023-01-15
Date 2: 2023-03-20
Difference in days: 64

A classe date do módulo datetime nos permite criar objetos de data especificando o ano, mês e dia. Quando subtraímos uma data de outra, o Python retorna um objeto timedelta. Podemos acessar o número de dias neste objeto usando o atributo .days.

Neste exemplo, há 64 dias entre 15 de janeiro de 2023 e 20 de março de 2023.

Criando a Função de Diferença de Meses

Agora que entendemos como trabalhar com objetos de data e calcular a diferença em dias, vamos criar uma função para calcular a diferença em meses.

Em muitas aplicações, um mês é aproximado como 30 dias. Embora isso nem sempre seja preciso (os meses podem ter de 28 a 31 dias), é uma simplificação comum que funciona bem para muitos cálculos comerciais.

Abra seu arquivo month_difference.py e adicione esta função abaixo do seu código existente:

def months_diff(start, end):
    """
    Calculate the difference in months between two dates.

    Args:
        start (date): The start date
        end (date): The end date

    Returns:
        int: The number of months between the dates (rounded up)
    """
    ## Calculate the difference in days
    days_difference = (end - start).days

    ## Convert days to months (assuming 30 days per month) and round up
    months = ceil(days_difference / 30)

    return months

Vamos entender o que esta função faz:

Ela recebe dois parâmetros: start e end, que são objetos de data
Ela calcula a diferença em dias entre essas datas
Ela divide por 30 para converter dias em meses
Ela usa ceil() para arredondar para o inteiro mais próximo
Ela retorna o resultado como um inteiro

A função ceil() é usada porque em muitos cenários de negócios, mesmo um mês parcial é contado como um mês inteiro para fins de faturamento.

Para testar nossa função, adicione o seguinte código no final do seu arquivo:

## Test the months_diff function with our example dates
print(f"Months between {date1} and {date2}: {months_diff(date1, date2)}")

## Test with some other date pairs
print(f"Months between 2020-10-28 and 2020-11-25: {months_diff(date(2020, 10, 28), date(2020, 11, 25))}")
print(f"Months between 2020-12-15 and 2021-01-10: {months_diff(date(2020, 12, 15), date(2021, 01, 10))}")

Salve seu arquivo e execute-o novamente:

python3 ~/project/month_difference.py

Você deve ver uma saída como:

Date 1: 2023-01-15
Date 2: 2023-03-20
Difference in days: 64
Months between 2023-01-15 and 2023-03-20: 3
Months between 2020-10-28 and 2020-11-25: 1
Months between 2020-12-15 and 2021-01-10: 1

Observe que:

Os 64 dias entre 2023-01-15 e 2023-03-20 são calculados como 3 meses (64/30 = 2.13, arredondado para cima para 3)
A diferença entre 28 de outubro e 25 de novembro é calculada como 1 mês
A diferença entre 15 de dezembro e 10 de janeiro (atravessando uma fronteira de ano) também é calculada como 1 mês

Testando com Vários Cenários de Data

Para entender melhor como nossa função months_diff funciona com diferentes cenários de data, vamos criar um arquivo de teste separado. Essa abordagem é comum no desenvolvimento de software para verificar se nosso código funciona como esperado.

Crie um novo arquivo chamado month_diff_test.py no diretório /home/labex/project:

from datetime import date
from month_difference import months_diff

## Test scenario 1: Dates in the same month
date1 = date(2023, 5, 5)
date2 = date(2023, 5, 25)
print(f"Same month: {months_diff(date1, date2)} month(s)")

## Test scenario 2: Consecutive months
date3 = date(2023, 6, 28)
date4 = date(2023, 7, 15)
print(f"Consecutive months: {months_diff(date3, date4)} month(s)")

## Test scenario 3: Dates crossing year boundary
date5 = date(2023, 12, 20)
date6 = date(2024, 1, 10)
print(f"Across years: {months_diff(date5, date6)} month(s)")

## Test scenario 4: Several months apart
date7 = date(2023, 3, 10)
date8 = date(2023, 9, 20)
print(f"Several months: {months_diff(date7, date8)} month(s)")

## Test scenario 5: Dates in reverse order (negative result)
print(f"Reverse order: {months_diff(date8, date7)} month(s)")

## Test scenario 6: Exact multiples of 30 days
date9 = date(2023, 1, 1)
date10 = date(2023, 1, 31)  ## 30 days
date11 = date(2023, 3, 2)   ## 60 days
print(f"30 days exactly: {months_diff(date9, date10)} month(s)")
print(f"60 days exactly: {months_diff(date9, date11)} month(s)")

Salve este arquivo e execute-o:

python3 ~/project/month_diff_test.py

Você deve ver uma saída semelhante a:

Same month: 1 month(s)
Consecutive months: 1 month(s)
Across years: 1 month(s)
Several months: 7 month(s)
Reverse order: -7 month(s)
30 days exactly: 1 month(s)
60 days exactly: 2 month(s)

Vamos analisar esses resultados:

Mesmo mês: Mesmo dentro do mesmo mês, nossa função retorna 1 mês. Isso ocorre porque mesmo um mês parcial é contado como um mês inteiro.
Meses consecutivos: Para datas em meses consecutivos, a função retorna 1 mês.
Atravessando anos: Para datas que cruzam a fronteira do ano, a função ainda calcula corretamente.
Vários meses: Para datas que estão separados por vários meses, a função calcula o número apropriado de meses.
Ordem inversa: Quando a data final é anterior à data inicial, obtemos um resultado negativo, o que faz sentido para cenários como calcular o tempo restante.
Múltiplos exatos: Para exatamente 30 dias, obtemos 1 mês. Para 60 dias, obtemos 2 meses. Isso confirma que nossa função funciona como esperado com múltiplos exatos de nossa definição de mês.

Nossa função months_diff lida com todos esses casos de teste corretamente de acordo com nossa definição de um mês como 30 dias.

Criando uma Aplicação Prática: Calculadora de Assinatura

Agora que temos uma função confiável para calcular diferenças de meses, vamos aplicá-la a um cenário do mundo real. Criaremos uma calculadora de assinatura que determina o custo de uma assinatura de serviço entre duas datas.

Crie um novo arquivo chamado subscription_calculator.py no diretório /home/labex/project:

from datetime import date, timedelta
from month_difference import months_diff

def calculate_subscription_cost(start_date, end_date, monthly_fee):
    """
    Calculate the total cost of a subscription between two dates.

    Args:
        start_date (date): Subscription start date
        end_date (date): Subscription end date
        monthly_fee (float): Cost per month

    Returns:
        float: Total subscription cost
    """
    ## Calculate number of months
    months = months_diff(start_date, end_date)

    ## Calculate total cost
    total_cost = months * monthly_fee

    return total_cost

## Example: Calculate subscription cost for a streaming service
start = date(2023, 1, 15)  ## Subscription starts January 15, 2023
end = date(2023, 8, 20)    ## Ends August 20, 2023
monthly_cost = 9.99        ## $9.99 per month

total = calculate_subscription_cost(start, end, monthly_cost)
print(f"Subscription period: {start} to {end}")
print(f"Monthly fee: ${monthly_cost:.2f}")
print(f"Total cost: ${total:.2f}")

## Compare with an annual plan
annual_cost = 99.99  ## $99.99 per year
print(f"\nAnnual plan cost: ${annual_cost:.2f}")
print(f"Monthly plan for same period: ${total:.2f}")

if total > annual_cost:
    print(f"Savings with annual plan: ${total - annual_cost:.2f}")
else:
    print(f"Additional cost for annual plan: ${annual_cost - total:.2f}")

## Calculate cost for a trial period
today = date.today()
trial_end = today + timedelta(days=7)  ## 7-day trial
trial_cost = calculate_subscription_cost(today, trial_end, monthly_cost)
print(f"\nOne-week trial period: {today} to {trial_end}")
print(f"Trial period cost: ${trial_cost:.2f}")

Salve o arquivo e execute-o:

python3 ~/project/subscription_calculator.py

Você deve ver uma saída semelhante a esta (as datas de teste mostrarão sua data atual):

Subscription period: 2023-01-15 to 2023-08-20
Monthly fee: $9.99
Total cost: $79.92

Annual plan cost: $99.99
Monthly plan for same period: $79.92
Additional cost for annual plan: $20.07

One-week trial period: 2023-06-01 to 2023-06-08
Trial period cost: $9.99

Esta aplicação demonstra como nossa função months_diff pode ser usada em um cenário prático:

Calculamos o custo total de uma assinatura com base no número de meses entre duas datas
Comparamos esse custo com um plano anual para ajudar um usuário a decidir qual plano é mais econômico
Calculamos o custo de um curto período de teste

Observe como mesmo o teste de 7 dias é cobrado como um mês inteiro em nosso modelo. Isso ocorre porque nossa função arredonda qualquer mês parcial para um mês inteiro, o que é comum na cobrança de assinaturas.

Este tipo de cálculo é frequentemente usado em:

Serviços de assinatura (streaming, software, assinaturas)
Cálculos de empréstimos e hipotecas
Acordos de aluguel
Faturamento de projetos

Resumo

Neste laboratório, você aprendeu a calcular a diferença de meses entre duas datas em Python. Aqui está o que você realizou:

Você aprendeu a trabalhar com objetos de data do módulo datetime
Você criou uma função months_diff que calcula diferenças de meses usando uma aproximação de mês de 30 dias
Você testou a função com vários cenários de data para garantir que ela funcione corretamente
Você aplicou a função a um cenário do mundo real, criando uma calculadora de assinatura

Essas habilidades são valiosas para muitas aplicações, incluindo:

Cálculos financeiros (empréstimos, investimentos, faturamento)
Planejamento e gerenciamento de projetos
Serviços de assinatura
Análise de dados baseada em datas

Para aprimorar ainda mais suas habilidades em trabalhar com datas em Python, você pode explorar:

Trabalhar com componentes de tempo usando datetime.datetime
Lidar com diferentes fusos horários usando a biblioteca pytz
Usar a biblioteca dateutil para operações de data mais avançadas
Implementar diferentes abordagens para calcular diferenças de meses (por exemplo, meses do calendário em vez de períodos de 30 dias)

Cálculos de data e hora são essenciais em muitas tarefas de programação, e as técnicas que você aprendeu neste laboratório fornecem uma base sólida para lidar com esses cálculos em seus projetos Python.

Calcular Diferença de Meses em Python