Add --every / -e option to the new command

AUTHORS.txt

@@ -44,3 +44,4 @@ Yorick Barbanneau - git [at] epha [dot] se - https://xieme-art.org
 Florian Lassenay - pizzacoca [at] aquilenet [dot] fr
 Simon Crespeau - simon [at] art-e-toile [dot] com - https://www.art-e-toile.com
 Fred Thomsen - me [at] fredthomsen [dot] net - http://fredthomsen.net
+Allan Wind - [email protected]

CHANGELOG.rst

@@ -14,6 +14,7 @@ not released
 
 * DROPPED support for Python 3.5
 * CHANGE: ikhal: tab (and shift tab) jump from the events back to the calendar
+* NEW Add --every / -e to support INTERVAL on the command line
 
 0.10.3
 ======

doc/source/usage.rst

@@ -412,6 +412,10 @@ Options
 
 * **-u, --until=UNTIL** specify until when a recurring event should run
 
+* **-e, --every=EVERY** specify at what interval a recurring event
+  should run. For instance, if RRULE is weekly and EVERY is 2, it
+  would schedule the event every 2 weeks.
+
 * **--url** specify the URL element of the event
 
 * **--alarms DURATION,...** will add alarm times as DELTAs comma separated for this event,

khal/cli.py

@@ -341,6 +341,9 @@ def klist(ctx, include_calendar, exclude_calendar,
                   help=('Repeat event: daily, weekly, monthly or yearly.'))
     @click.option('--until', '-u',
                   help=('Stop an event repeating on this date.'))
+    @click.option('--every', '-e',
+                  help=('Frequency for repeating events.'),
+                  type=click.INT)
     @click.option('--format', '-f',
                   help=('The format to print the event.'))
     @click.option('--alarms', '-m',
@@ -349,7 +352,7 @@ def klist(ctx, include_calendar, exclude_calendar,
     @click.argument('info', metavar='[START [END | DELTA] [TIMEZONE] [SUMMARY] [:: DESCRIPTION]]',
                     nargs=-1)
     @click.pass_context
-    def new(ctx, calendar, info, location, categories, repeat, until, alarms, url, format,
+    def new(ctx, calendar, info, location, categories, repeat, until, every, alarms, url, format,
             interactive):
         '''Create a new event from arguments.
 
@@ -395,6 +398,7 @@ def new(ctx, calendar, info, location, categories, repeat, until, alarms, url, f
                 repeat=repeat,
                 env={"calendars": ctx.obj['conf']['calendars']},
                 until=until,
+                every=every,
                 alarms=alarms,
                 url=url,
                 format=format,

khal/controllers.py

@@ -279,7 +279,7 @@ def khal_list(collection, daterange=None, conf=None, agenda_format=None,
 
 
 def new_interactive(collection, calendar_name, conf, info, location=None,
-                    categories=None, repeat=None, until=None, alarms=None,
+                    categories=None, repeat=None, until=None, every=None, alarms=None,
                     format=None, env=None, url=None):
     try:
         info = parse_datetime.eventinfofstr(
@@ -326,14 +326,14 @@ def new_interactive(collection, calendar_name, conf, info, location=None,
         except pytz.UnknownTimeZoneError:
             echo("unknown timezone")
 
-    info['description'] = prompt("description (or 'None')", default=info.get('description'))
+    info['description'] = prompt('description (or "None")', default=info.get('description'))
     if info['description'] == 'None':
         info['description'] = ''
 
     event = new_from_args(
         collection, calendar_name, conf, format=format, env=env,
         location=location, categories=categories,
-        repeat=repeat, until=until, alarms=alarms, url=url,
+        repeat=repeat, until=until, every=every, alarms=alarms, url=url,
         **info)
 
     echo("event saved")
@@ -343,7 +343,7 @@ def new_interactive(collection, calendar_name, conf, info, location=None,
 
 
 def new_from_string(collection, calendar_name, conf, info, location=None,
-                    categories=None, repeat=None, until=None, alarms=None,
+                    categories=None, repeat=None, until=None, every=None, alarms=None,
                     url=None, format=None, env=None):
     """construct a new event from a string and add it"""
     info = parse_datetime.eventinfofstr(
@@ -355,21 +355,21 @@ def new_from_string(collection, calendar_name, conf, info, location=None,
     new_from_args(
         collection, calendar_name, conf, format=format, env=env,
         location=location, categories=categories, repeat=repeat,
-        until=until, alarms=alarms, url=url, **info
+        until=until, every=every, alarms=alarms, url=url, **info
     )
 
 
 def new_from_args(collection, calendar_name, conf, dtstart=None, dtend=None,
                   summary=None, description=None, allday=None, location=None,
-                  categories=None, repeat=None, until=None, alarms=None,
+                  categories=None, repeat=None, until=None, every=None, alarms=None,
                   timezone=None, url=None, format=None, env=None):
     """Create a new event from arguments and add to vdirs"""
     if isinstance(categories, str):
         categories = [category.strip() for category in categories.split(',')]
     try:
         event = new_vevent(
             locale=conf['locale'], location=location, categories=categories,
-            repeat=repeat, until=until, alarms=alarms, dtstart=dtstart,
+            repeat=repeat, until=until, every=every, alarms=alarms, dtstart=dtstart,
             dtend=dtend, summary=summary, description=description, timezone=timezone, url=url,
         )
     except ValueError as error:
@@ -413,6 +413,24 @@ def present_options(options, prefix="", sep="  ", width=70):
         return None
 
 
+def prompt_none(text, default=None, lower=False, type=None):
+    # icalendar.prop.vRecur returns list values for frequency, until and
+    # interval with one element.  However, when creating an event with
+    # new -i they are str values.
+    if isinstance(default, list):
+        default = default[0]
+
+    # icalendar.prop.vRecur return the freq value in upper case,
+    # however we only accept lower case values.  For consistency
+    # with the interactive mode conver the value for lowercase
+    # for display.
+    if isinstance(default, str) and lower:
+        default = default.lower()
+
+    v = prompt(text + ' (or "None")', default=default or "None", type=type)
+    return v if v != "None" else None
+
+
 def edit_event(event, collection, locale, allow_quit=False, width=80):
     options = OrderedDict()
     if allow_quit:
@@ -458,20 +476,14 @@ def edit_event(event, collection, locale, allow_quit=False, width=80):
             except:  # noqa
                 echo("error parsing range")
         elif choice == "repeat":
-            recur = event.recurobject
-            freq = recur["freq"] if "freq" in recur else ""
-            until = recur["until"] if "until" in recur else ""
-            if not freq:
-                freq = 'None'
-            freq = prompt('frequency (or "None")', freq)
-            if freq == 'None':
-                event.update_rrule(None)
+            freq = prompt_none("frequency", event.recurobject.get("freq"), lower=True)
+            if freq:
+                until = prompt_none("until", event.recurobject.get("until"))
+                interval = prompt_none("interval", event.recurobject.get("interval"), int)
+                rrule = parse_datetime.rrulefstr(freq, until, interval, locale)
             else:
-                until = prompt('until (or "None")', until)
-                if until == 'None':
-                    until = None
-                rrule = parse_datetime.rrulefstr(freq, until, locale)
-                event.update_rrule(rrule)
+                rrule = None
+            event.update_rrule(rrule)
             edited = True
         elif choice == "alarm":
             default_alarms = []

khal/icalendar.py

@@ -71,7 +71,7 @@ def split_ics(ics, random_uid=False, default_timezone=None):
 
 def new_event(locale, dtstart=None, dtend=None, summary=None, timezone=None,
               allday=False, description=None, location=None, categories=None,
-              repeat=None, until=None, alarms=None, url=None):
+              repeat=None, until=None, every=None, alarms=None, url=None):
     """create a new event
 
     :param dtstart: starttime of that event
@@ -121,7 +121,7 @@ def new_event(locale, dtstart=None, dtend=None, summary=None, timezone=None,
     if url:
         event.add('url', icalendar.vUri(url))
     if repeat and repeat != "none":
-        rrule = rrulefstr(repeat, until, locale)
+        rrule = rrulefstr(repeat, until, every, locale)
         event.add('rrule', rrule)
     if alarms:
         for alarm in alarms.split(","):

khal/parse_datetime.py

@@ -413,12 +413,20 @@ def guessrangefstr(daterange, locale,
     )
 
 
-def rrulefstr(repeat, until, locale):
+def rrulefstr(repeat, until, every, locale):
     if repeat in ["daily", "weekly", "monthly", "yearly"]:
         rrule_settings = {'freq': repeat}
         if until:
             until_dt, is_date = guessdatetimefstr(until.split(' '), locale)
             rrule_settings['until'] = until_dt
+        if every:
+            try:
+                int(every)
+            except ValueError:
+                logger.fatal("Invalid value for every option. " +
+                             "Must be an integer")
+                raise FatalError()
+            rrule_settings['interval'] = every
         return rrule_settings
     else:
         logger.fatal("Invalid value for the repeat option. \

tests/cli_test.py

@@ -879,6 +879,7 @@ def test_new_interactive_extensive(runner):
         'l\non a boat\n'
         'p\nweekly\n'
         '1.1.2018\n'
+        '1\n'
         'a\n30m\n'
         'c\nwork\n'
         'n\n'